docs: clean-up Local Orbital Frame comments

[phc1990]

Summary by CodeRabbit

• Documentation
  • Updated documentation comments for Local Vertical/Local Horizontal (LVLH) and Velocity/Local Vertical/Local Horizontal (VVLH) frame transformations
  • Clarified axis orientation descriptions for coordinate frame definitions

[coderabbitai]

Walkthrough

The pull request involves updating the documentation and comments for the LocalOrbitalFrameTransformProvider in both the header and implementation files. The changes focus on clarifying the axis orientations for the LVLH and VVLH (Local and Velocity Local Vertical Local Horizontal) coordinate frames. The modifications provide more precise descriptions of how the coordinate axes are aligned, specifically for the Y and Z axes, without changing the underlying computational logic of the frame transformations.

Changes

File	Change Summary
include/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.hpp	Updated VVLH enum comment to clarify axis orientation
src/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.cpp	Refined comments for LVLH and VVLH frame transformations, specifying axis alignments

Poem

🚀 Orbital frames, oh so precise,
Axes dancing with mathematical might,
Y and Z, now clearly defined,
A coordinate ballet, elegantly aligned!
Rabbits of science, rejoice in delight! 🛰️

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef11d30 and 94d3959.

📒 Files selected for processing (2)

• include/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.hpp (1 hunks)
• src/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.cpp (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• include/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.hpp

🔇 Additional comments (1)

src/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.cpp (1)

170-170: LGTM! Documentation accurately reflects the implementation.

The comment update correctly describes that the Z axis is aligned with the negative position vector, which matches the implementation where zAxis = -aPosition.normalized().

Let's verify consistency with the header file documentation:

✅ Verification successful

Documentation is consistent across header and implementation files

The Z axis orientation for the VVLH frame is consistently documented:

• Header: "Z axis aligned with opposite of position"
• Implementation: "Z axis along negative position vector"

Both descriptions accurately reflect the code implementation using -aPosition.normalized().

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the VVLH axis documentation in the header file matches the implementation file
rg -A 2 "VVLH" include/OpenSpaceToolkit/Astrodynamics/Trajectory/LocalOrbitalFrameTransformProvider.hpp

Length of output: 367

Finishing Touches

• 📝 Generate Docstrings

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.21%. Comparing base (ef11d30) to head (94d3959).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #487   +/-   ##
=======================================
  Coverage   91.21%   91.21%           
=======================================
  Files          86       86           
  Lines        8720     8720           
=======================================
  Hits         7954     7954           
  Misses        766      766           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.