DOC: Update docstrings in markov/ddp.jl to follow style guide#339
Merged
Conversation
Co-authored-by: YiningFu2003 <209427035+YiningFu2003@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update docstrings in markov/ddp.jl
DOC: Update docstrings in markov/ddp.jl to follow style guide
Oct 20, 2025
oyamad
marked this pull request as ready for review
October 20, 2025 11:11
Closed
oyamad
requested changes
Oct 20, 2025
| - `ddp::DiscreteDP` : Object that contains the Model Parameters | ||
| - `method::Type{T<Algo}(VFI)`: Type name specifying solution method. | ||
| - `ddp::DiscreteDP`: Object that contains the model parameters. | ||
| - `method::Type{T<:DDPAlgorithm}(VFI)`: Type name specifying solution method. |
Member
There was a problem hiding this comment.
Suggested change
| - `method::Type{T<:DDPAlgorithm}(VFI)`: Type name specifying solution method. | |
| - `method::Type{<:DDPAlgorithm}(VFI)`: Type name specifying solution method. |
Does this make sense?
Contributor
Author
There was a problem hiding this comment.
Fixed in commit c19c30e. Changed Type{T<:DDPAlgorithm} to Type{<:DDPAlgorithm} which is more accurate since T is not defined in the docstring context.
| # Returns | ||
|
|
||
| - `ddpr::DPSolveResult{Algo}` : Optimization result represented as a | ||
| - `ddpr::DPSolveResult{Algo}`: Optimization result represented as a |
Member
There was a problem hiding this comment.
Suggested change
| - `ddpr::DPSolveResult{Algo}`: Optimization result represented as a | |
| - `ddpr::DPSolveResult{<:DDPAlgorithm}`: Optimization result represented as a |
Contributor
Author
There was a problem hiding this comment.
Fixed in commit c19c30e. Changed DPSolveResult{Algo} to DPSolveResult{<:DDPAlgorithm} to be more explicit about the type parameter constraint.
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 20, 2025
YiningFu2003
approved these changes
Nov 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.
All docstrings in markov/ddp.jl have been successfully updated to follow the style guide. Changes include:
Type{T<:DDPAlgorithm}→Type{<:DDPAlgorithm}andDPSolveResult{Algo}→DPSolveResult{<:DDPAlgorithm}Original prompt
Fixes #335
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.