Some documentation cleanup for the JOSS review #474
Merged
Conversation
This file contains 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 a "Why Dymos?" section to the documentation to cover the statement of need. Added phase interpolate method to the documentation.
Kenneth-T-Moore
requested changes
Dec 1, 2020
naylor-b
reviewed
Dec 1, 2020
Fixed errant argument in link_phases documentation.
Kenneth-T-Moore
approved these changes
Dec 2, 2020
4 tasks
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.
Summary
Adds installation section to the documentation with more thorough instructions for the advanced prerequisites.
Adds a "Why Dymos?" section to the documentation to cover the statement of need for JOSS.
Adds
interpolate,add_boundary_constraint, andadd_path_constraintmethods to the phase API documentation.Adds instructions for running tests locally to the contribution documentation.
Related Issues
phase.interpolateis not included in the Phase API reference #473add boundary_constraintis missing from the phase api reference #470Status
Backwards incompatibilities
None
New Dependencies
None