Skip to content

DOC: Standardize docstrings in quadsums.jl to follow style guide#351

Merged
oyamad merged 3 commits intomasterfrom
copilot/update-docstrings-quadsums
Nov 3, 2025
Merged

DOC: Standardize docstrings in quadsums.jl to follow style guide#351
oyamad merged 3 commits intomasterfrom
copilot/update-docstrings-quadsums

Conversation

Copy link
Contributor

Copilot AI commented Oct 27, 2025

  • Analyze quadsums.jl docstrings against style guide
  • Update var_quadratic_sum docstring formatting
    • Added four-space indented function signature
    • Changed section headers from ##### to #
    • Added blank lines after section headers
    • Removed spaces before colons in parameter descriptions
    • Ensured all descriptions end with periods
    • Fixed typo: "condtion" → "condition"
    • Broke long lines at 92 characters or less
  • Update m_quadratic_sum docstring formatting
    • Added four-space indented function signature
    • Changed section headers from ##### to #
    • Added blank lines after section headers
    • Removed spaces before colons in parameter descriptions
    • Ensured all descriptions end with periods
    • Removed extra spaces in text
    • Broke long lines at 92 characters or less
  • Test documentation build - passed without errors
  • Run validation scenarios - all tests passed
  • Final review and completion
Original prompt

This section details on the original issue you should resolve

<issue_title>DOC: Update docstrings in quadsums.jl</issue_title>
<issue_description>Follow the instruction in .github/copilot-instructions.md.

Scope: Only edit docstrings in quadsums.jl</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Haruki1225 <209430957+Haruki1225@users.noreply.github.com>
Copilot AI changed the title [WIP] Update docstrings in quadsums.jl DOC: Standardize docstrings in quadsums.jl to follow style guide Oct 27, 2025
Copilot AI requested a review from Haruki1225 October 27, 2025 05:26
@oyamad oyamad mentioned this pull request Oct 27, 2025
@oyamad oyamad marked this pull request as ready for review October 27, 2025 11:53
Copy link
Contributor

@Haruki1225 Haruki1225 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot
Some docstring lines are too long. Break lines (of docstring) at 92 characters (or less).

Co-authored-by: Haruki1225 <209430957+Haruki1225@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 3, 2025

@copilot
Some docstring lines are too long. Break lines (of docstring) at 92 characters (or less).

Fixed in commit 62cd559. All docstring lines now break at 92 characters or less.

@oyamad oyamad merged commit 5982cb2 into master Nov 3, 2025
20 checks passed
@oyamad oyamad deleted the copilot/update-docstrings-quadsums branch November 4, 2025 05:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Update docstrings in quadsums.jl

3 participants