Solver doc fix #817
Merged
Solver doc fix #817
Conversation
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
Added types for each parameter in documentation if missing. Completed missing documentation for parameters when missing.
Put parameters in order they appear in function constructor. Fixed a few mispellings
1 task
BryanRumsey
requested changes
May 31, 2022
Contributor
BryanRumsey
left a comment
BryanRumsey
left a comment
There was a problem hiding this comment.
All of the solver have missing or incomplete class level documentation.
Some of the solvers are missing documentation for public functions
Still need to add kwargs documentation
Added Solver docs for cpp solvers, finished python solver docs
BryanRumsey
requested changes
Jun 19, 2022
BryanRumsey
approved these changes
Jun 28, 2022
mdip226
reviewed
Jun 29, 2022
Contributor
mdip226
left a comment
mdip226
left a comment
There was a problem hiding this comment.
Just minor changes so that there is a uniform format throughout. Nothing major, looks good! Some of my comments are just me thinking and may not require a change at all.
Changed variable parameter documentation in c solvers
mdip226
requested changes
Jul 14, 2022
Contributor
mdip226
left a comment
mdip226
left a comment
There was a problem hiding this comment.
Just a few missing words, after that, good to merge I'd say.
BryanRumsey
requested changes
Jul 16, 2022
briandrawert
approved these changes
Aug 9, 2022
Merged
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.
Updated and fleshed out numpy solver documentation.