Refactor the documentation of the Ellipsoid class #127
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
Add more docstring info for each derived attribute. Standardize the maths and unit representations. Add more context to the methods docs, including a citation to Lakshmanan (1991) for the original derivation of general normal gravity. Includes some tweaks to the autosummary template for classes.
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.
Description
Add more docstring info for each derived attribute. Standardize the
maths and unit representations. Add more context to the methods docs,
including a citation to Lakshmanan (1991) for the original derivation of
general normal gravity. Includes some tweaks to the autosummary template
for classes and slight re-definitions of derived attributes to be based
on the flattening when possible.
Relevant issues/PRs