-
-
Notifications
You must be signed in to change notification settings - Fork 306
DOC: Update docstrings in quad.jl to follow style guide #331
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Update docstrings in quad.jl to follow style guide #331
Conversation
Co-authored-by: oyamad <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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 <[email protected]>
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:
|
|
@copilot Update the docstring of |
…urns sections Co-authored-by: oyamad <[email protected]>
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:
|
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.