DOC: Update docstrings in compute_fp.jl to follow standardized style guide#315
Merged
DOC: Update docstrings in compute_fp.jl to follow standardized style guide#315
Conversation
Co-authored-by: oyamad <7353083+oyamad@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] DOC: Update docstrings in compute_fp.jl
DOC: Update docstrings in compute_fp.jl to follow standardized style guide
Sep 4, 2025
oyamad
reviewed
Sep 4, 2025
oyamad
reviewed
Sep 4, 2025
oyamad
reviewed
Sep 4, 2025
oyamad
reviewed
Sep 4, 2025
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:
|
…les section 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
requested changes
Sep 4, 2025
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
Sep 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.
Updates the docstring in
src/compute_fp.jlto follow the standardized style guide established in the Copilot instructions and demonstrated in issue #313.Key improvements:
Function signature formatting: Updated to use proper 4-space indentation with complete parameter list
Section headers: Converted from old-style
##### Argumentsto standardized single#format with proper spacingParameter descriptions: Standardized to bullet format with consistent type annotations and proper punctuation
Examples section: Converted to proper REPL-style format showing actual convergence output and cleaned up redundant imports
Mathematical expressions: Uses plain
<character following Julia docstring conventions rather than HTML entitiesThe updated docstring maintains all existing functionality while providing clearer, more consistent documentation that aligns with established patterns across the QuantEcon.jl codebase.
Fixes #314.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.