- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 305
DOC: Update docstrings in markov/ddp.jl to follow style guide #339
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
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: YiningFu2003 <[email protected]>
        
          
                src/markov/ddp.jl
              
                Outdated
          
        
      | - `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. | 
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.
| - `method::Type{T<:DDPAlgorithm}(VFI)`: Type name specifying solution method. | |
| - `method::Type{<:DDPAlgorithm}(VFI)`: Type name specifying solution method. | 
Does this make sense?
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.
Fixed in commit c19c30e. Changed Type{T<:DDPAlgorithm} to Type{<:DDPAlgorithm} which is more accurate since T is not defined in the docstring context.
        
          
                src/markov/ddp.jl
              
                Outdated
          
        
      | # Returns | ||
| - `ddpr::DPSolveResult{Algo}` : Optimization result represented as a | ||
| - `ddpr::DPSolveResult{Algo}`: Optimization result represented as a | 
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.
| - `ddpr::DPSolveResult{Algo}`: Optimization result represented as a | |
| - `ddpr::DPSolveResult{<:DDPAlgorithm}`: Optimization result represented as a | 
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.
Fixed in commit c19c30e. Changed DPSolveResult{Algo} to DPSolveResult{<:DDPAlgorithm} to be more explicit about the type parameter constraint.
Co-authored-by: oyamad <[email protected]>
| 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: 
 | 
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.