-
Notifications
You must be signed in to change notification settings - Fork 0
docs: update anise tutorial and add to index #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @ChristopherRabotin, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on refining the ANISE tutorial that covers the use of frame kernels and text planetary kernels. The changes aim to make the tutorial content more precise, grammatically correct, and easier to follow for users. Additionally, the documentation's navigation has been enhanced to ensure that information regarding Euler parameter ANISE (EPA) kernels is more readily discoverable, ultimately improving the overall user experience and clarity of the ANISE documentation. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the ANISE tutorial on frame and planetary kernels with several grammatical fixes, typo corrections, and formatting improvements. It also adds a new entry for the tutorial in the documentation's navigation index. The changes enhance the clarity and correctness of the documentation. I have one suggestion regarding the new navigation entry to avoid redundancy.
mkdocs.yml
Outdated
| - Working with Orbit class: anise/tutorials/Tutorial 03 - Defining and working with the Orbit structure.ipynb | ||
| - Azimuth, Elevation, Range (AER): anise/tutorials/Tutorial 04 - Computing Azimuth Elevation and Range data.ipynb | ||
| - Planetary constant kernels (PCK): anise/tutorials/Tutorial 05 - Using frame kernels and text planetary kernels.ipynb | ||
| - Euler parameter ANISE (EPA) kernels: anise/tutorials/Tutorial 05 - Using frame kernels and text planetary kernels.ipynb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While adding a separate entry for 'Euler parameter ANISE (EPA) kernels' improves discoverability, it also creates redundancy in the navigation menu as it points to the same tutorial as 'Planetary constant kernels (PCK)' on the preceding line.
To create a cleaner navigation experience, consider combining these two entries into a single, more descriptive one. This would involve replacing both lines 98 and 99 with something like:
- Custom Kernels (PCK & EPA): anise/tutorials/Tutorial 05 - Using frame kernels and text planetary kernels.ipynb|
Visit the preview URL for this PR (updated for commit 92551a6): https://nyx-space--pr32-docs-update-anise-tu-mz23n9x5.web.app (expires Mon, 20 Oct 2025 00:28:00 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: ecf6068ed4b2d3d429c02e3ebe5890356e4315eb |
No description provided.