docs: clarify altitude definition in Orbit constructors #475
Conversation
WalkthroughThe pull request focuses on improving documentation for the Changes
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (6)bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp (6)
The addition of "(wrt. equatorial radius)" to the altitude parameter documentation improves clarity by explicitly stating the reference point for altitude measurements.
The addition of "(wrt. equatorial radius)" to both apoapsis and periapsis altitude parameters maintains consistency and clarity in the documentation.
The addition of "(wrt. equatorial radius)" to the altitude parameter documentation maintains consistency with other methods.
The addition of "(wrt. equatorial radius)" to the altitude parameter documentation maintains consistency across all orbit constructors.
The addition of "(wrt. equatorial radius)" to the altitude parameter documentation completes the consistent documentation update across all orbit constructors. Line range hint The changes consistently clarify that all altitude measurements are with respect to the equatorial radius, which is a valuable improvement to the API documentation. The updates are thorough, covering all relevant methods (circular, equatorial, circular_equatorial, sun_synchronous, and frozen), while appropriately excluding methods that don't use altitude parameters (like geo_synchronous). Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #475 +/- ##
=======================================
Coverage 91.21% 91.21%
=======================================
Files 86 86
Lines 8720 8720
=======================================
Hits 7954 7954
Misses 766 766 ☔ View full report in Codecov by Sentry. |
apaletta3
changed the title
apaletta3
changed the title
Clarifies in the
Orbitbindings that altitude is relative to equatorial radius, matching what's already inOrbit.hpp.Summary by CodeRabbit
Orbitmethods to clarify that altitude parameters are specified with respect to the equatorial radius. Methods include:circular,equatorial,circular_equatorial,geo_synchronous,sun_synchronous, andfrozen.