DOC: Update docstrings in estspec.jl to follow style guide#333
Merged
DOC: Update docstrings in estspec.jl to follow style guide#333
Conversation
Co-authored-by: UdohNakamura <159118172+UdohNakamura@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update docstrings in estspec.jl
DOC: Update docstrings in estspec.jl to follow style guide
Oct 19, 2025
oyamad
reviewed
Oct 19, 2025
| return w, I_w | ||
| end | ||
|
|
||
| @doc doc""" |
Member
There was a problem hiding this comment.
@copilot Do not remove @doc doc.
And do not add an escape character \ to \frac, \sum, \pi, \ldots, etc.
- Record this (i.e., "Do not remove
@doc doc" or "Preserve the original formatting with@doc doc") in.github/copilot-instructions.mdfor future tasks.
Contributor
Author
There was a problem hiding this comment.
Fixed in commit c7f8e1a. Preserved @doc doc formatting and kept LaTeX commands with single backslash (\frac, \sum, \pi, \ldots). Also updated .github/copilot-instructions.md to document these rules for future reference.
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:
|
oyamad
approved these changes
Oct 19, 2025
Closed
UdohNakamura
approved these changes
Oct 20, 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.
smoothfunction docstring to follow style guide (add signature, fix headers, add periods, add blank lines)smoothfunction docstringperiodogramfunction docstring to follow style guide while preserving@doc docand LaTeX commandsar_periodogramfunction docstring to follow style guide@doc docpreservation rule in.github/copilot-instructions.mdAll docstrings in
estspec.jlhave been updated to follow the style guide from.github/copilot-instructions.md:#####to single#ArraytoVectorwhere appropriate for better type specificity@doc doc"""format for theperiodogramfunction (no longer converted to plain""")\frac,\sum,\pi,\ldots(no double escaping)Documentation Update
Added guidelines in
.github/copilot-instructions.mdto:@doc docformatting when present (used for mathematical notation)Original prompt
Fixes #332
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.