DOC: Update docstrings in quad.jl to follow style guide - #331
Merged
Conversation
Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] DOC: Update docstrings in quad.jl
DOC: Update docstrings in quad.jl to follow style guide
Oct 4, 2025
oyamad
requested changes
Oct 4, 2025
oyamad
left a comment
Member
There was a problem hiding this comment.
- Respect the linebreaks in the original version.
- There are (exported) functions for which docstring is still missing:
qnwmonomial1,qnwmonomial2. - Update the docstring of
qnwdist.
Its header should beqnwdist(d, N; q0=0.001, qN=0.999, method=Quantile)
…rings Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
Fixed in commit 04f0bcb:
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:
|
Member
|
@copilot Update the docstring of |
…urns sections Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Contributor
Author
Updated in commit 4e0a5e4. The qnwdist docstring now follows the style guide with proper 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
marked this pull request as ready for review
October 4, 2025 12:06
oyamad
approved these changes
Oct 4, 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.
Summary of Changes
Updated all docstrings in
src/quad.jlto conform to the project's docstring style guide while respecting the original formatting:Formatting Updates (Preserving Linebreaks)
#####to single#New Docstrings Added
qnwmonomial1: Monomial integration using first-order ruleqnwmonomial2: Monomial integration using second-order ruleUpdated Docstrings
qnwdist:qnwdist(d, N; q0=0.001, qN=0.999, method=Quantile)# Argumentssection with detailed parameter descriptions# Returnssection# Notessection for explanation of weight constructionAll changes tested and validated.
Original prompt
💡 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.