improve documentation of orbitalMotion.py
#1203
Open
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
schaubh
force-pushed
the
feature/explain_units
branch
from
492cfb6 to
4995b4f
Compare
Mark2000
approved these changes
Dec 1, 2025
Contributor
Mark2000
left a comment
Mark2000
left a comment
There was a problem hiding this comment.
Everything looks good to me. Made one comment for a possible but not necessary improvement.
| rPeriap = None | ||
| rApoap = None | ||
| __slots__ = ['a', 'e', 'i', 'Omega', 'omega', 'f', 'rmag', 'alpha', 'rPeriap', 'rApoap'] | ||
| def __init__(self): |
Contributor
There was a problem hiding this comment.
This could be a good place to use a dataclass instead of a standard class: https://docs.python.org/3/library/dataclasses.html
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
It was not clear what units
muandashould be.Also added hints the methods in
orbitalMotion.py.Verification
Documentation builds without issues.
Documentation
All unit tests pass.
Future work
None