Conversation
Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] DOC: Update docstrings in arma.jl
DOC: Update docstrings in arma.jl to follow new style guide
Sep 3, 2025
oyamad
requested changes
Sep 3, 2025
Member
oyamad
left a comment
oyamad
left a comment
There was a problem hiding this comment.
@copilot Try building the documentation so that it completes without docstring parsing errors/warnings introduced by this change. Add this procedure (documentation build testing) to the instruction in .github/copilot-instructions.md.
src/arma.jl
Outdated
| =# | ||
|
|
||
| @doc doc""" | ||
| ARMA(phi, theta, sigma) |
Member
There was a problem hiding this comment.
Suggested change
| ARMA(phi, theta, sigma) | |
| ARMA |
Do not add fields here. If a struct has type parameters, then show them; for example:
LinInterp{TV,TB}Update .github/copilot-instructions.md accordingly.
Contributor
Author
There was a problem hiding this comment.
Fixed the ARMA struct docstring to show just ARMA instead of ARMA(phi, theta, sigma) and updated the docstring style guide accordingly. Changes made in commit 1591073.
Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
Documentation build completed successfully without parsing errors. Added documentation build testing procedures to Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
DOC: Update docstrings in arma.jl to follow new style guide
DOC: Update docstrings in arma.jl to follow new style guide and add documentation build testing
Sep 3, 2025
Member
|
Replace this block with
|
… testing procedures - Updated ARMA docstring Examples section to use REPL-style format showing julia> prompts and expected output - Replaced problematic require/quad_plot example with simple ARMA construction example - Added Examples Section Testing procedures to .github/copilot-instructions.md - Added Examples section style guide to docstring conventions - Tested example works correctly and documentation builds without errors Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
Replaced the ARMA Examples section with the REPL-style format showing julia> prompts and expected output. Also added Examples section style guide and testing procedures to .github/copilot-instructions.md as requested. The example was tested to ensure it executes without error and produces the documented output. Changes made in commit 00ae1c6. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
DOC: Update docstrings in arma.jl to follow new style guide and add documentation build testing
DOC: Update ARMA docstring Examples to REPL format and add Examples testing procedures
Sep 3, 2025
oyamad
approved these changes
Sep 3, 2025
oyamad
reviewed
Sep 3, 2025
src/arma.jl
Outdated
|
|
||
| # Returns | ||
|
|
||
| - `::Vector{Float64}` : The autocovariance function |
Member
There was a problem hiding this comment.
Suggested change
| - `::Vector{Float64}` : The autocovariance function | |
| - `::Vector{Float64}`: The autocovariance function. |
Remove the space between "::Vector{Float64}" and ":". Also add a period ".".
- Follow the same pattern to other places. For example, remove the space in "
phi::Vector: AR parameters" before ":". - Record this pattern in the instruction in
.github/copilot-instructions.mdfuture tasks.
Contributor
Author
There was a problem hiding this comment.
Fixed the docstring parameter formatting by removing spaces before colons and adding periods. Applied this pattern consistently throughout the ARMA docstrings and updated the style guide in .github/copilot-instructions.md to document this formatting requirement. Documentation builds successfully without parsing errors. Changes made in commit bc1ef13.
…dd periods Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
DOC: Update ARMA docstring Examples to REPL format and add Examples testing procedures
DOC: Update ARMA docstring Examples to REPL format and standardize docstring formatting
Sep 3, 2025
oyamad
reviewed
Sep 3, 2025
src/arma.jl
Outdated
Comment on lines
+50
to
+56
| - `phi::Vector`: AR parameters ``\phi_1, \ldots, \phi_p`` | ||
| - `theta::Vector`: MA parameters ``\theta_1, \ldots, \theta_q`` | ||
| - `p::Integer`: Number of AR coefficients | ||
| - `q::Integer`: Number of MA coefficients | ||
| - `sigma::Real`: Standard deviation of white noise | ||
| - `ma_poly::Vector`: MA polynomial --- filtering representatoin | ||
| - `ar_poly::Vector`: AR polynomial --- filtering representation |
Member
There was a problem hiding this comment.
Suggested change
| - `phi::Vector`: AR parameters ``\phi_1, \ldots, \phi_p`` | |
| - `theta::Vector`: MA parameters ``\theta_1, \ldots, \theta_q`` | |
| - `p::Integer`: Number of AR coefficients | |
| - `q::Integer`: Number of MA coefficients | |
| - `sigma::Real`: Standard deviation of white noise | |
| - `ma_poly::Vector`: MA polynomial --- filtering representatoin | |
| - `ar_poly::Vector`: AR polynomial --- filtering representation | |
| - `phi::Vector`: AR parameters ``\phi_1, \ldots, \phi_p``. | |
| - `theta::Vector`: MA parameters ``\theta_1, \ldots, \theta_q``. | |
| - `p::Integer`: Number of AR coefficients. | |
| - `q::Integer`: Number of MA coefficients. | |
| - `sigma::Real`: Standard deviation of white noise. | |
| - `ma_poly::Vector`: MA polynomial --- filtering representation. | |
| - `ar_poly::Vector`: AR polynomial --- filtering representation. |
- Make sure that all the sentences (or descriptions) end with a period (within this file
arma.jl). - Correct any typos if any (within this file
arma.jl). - Record these procedures in the instruction in
.github/copilot-instructions.md.
Contributor
Author
There was a problem hiding this comment.
Fixed all docstring formatting issues in arma.jl: added periods to the end of all field descriptions, corrected typos ("representatoin" → "representation", "calcluating" → "calculating", "reponse" → "response"), and added quality control procedures to .github/copilot-instructions.md for systematic grammar and typo checking. Documentation builds successfully without errors. Changes made in commit 3ad6831.
Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
DOC: Update ARMA docstring Examples to REPL format and standardize docstring formatting
DOC: Update ARMA docstring Examples to REPL format, standardize formatting, and add quality control procedures
Sep 3, 2025
oyamad
requested changes
Sep 3, 2025
Member
oyamad
left a comment
oyamad
left a comment
There was a problem hiding this comment.
Task: Add trailing periods in docstrings (src/arma.jl)
Scope
- Only edit docstrings in
src/arma.jl. - No code/behavior changes.
Rule
- Ensure every sentence and every bullet description ends with a period (
.). - Allow
:,?, or!when intentional (e.g., a colon introducing a formula/list). - Do not add periods to headings (
# ...) or inside code/backticks.
Examples
Represents a scalar ARMA(p, q) process→Represents a scalar ARMA(p, q) process.Instance of ARMA type→Instance of ARMA type.
Acceptance
- All docstring sentences and bullet descriptions in
src/arma.jlend with.(or intentional: ? !). - No added periods in headings or code.
- Docs build cleanly.
Commit message
DOC: Ensure docstring sentences and bullet descriptions end with periods in src/arma.jl
…ods in src/arma.jl Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
... Added periods to all docstring sentences and bullet descriptions in src/arma.jl that were missing them. Documentation builds cleanly without parsing errors. Changes made in commit 85fce94. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
oyamad
approved these changes
Sep 3, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the ARMA docstring Examples section to use the standardized REPL-style format and establishes comprehensive testing and quality control procedures for documentation examples. Additionally, standardizes docstring parameter formatting across the ARMA module.
ARMA Examples section update:
Replaced the problematic Examples section that used external file dependencies (
requireandarma_plots.jl) and plotting functions with a clean REPL-style format. The new example showsjulia>prompts with expected output, demonstrating basic ARMA construction without external dependencies.Docstring formatting standardization:
Applied consistent formatting to all parameter descriptions in ARMA docstrings:
ARMAinstead of constructor parametersQuality improvements:
Enhanced documentation workflow:
Added comprehensive documentation standards to
.github/copilot-instructions.md:julia>promptsThe updated approach ensures documentation examples are self-contained, testable, and follow consistent formatting patterns that provide accurate demonstrations of package functionality with proper grammar and spelling.
Progress:
Fixes #312.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.