DOC: Add Flight class usage documentation and update index #841
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the Flight class to RocketPy's user guide. The documentation provides detailed guidance on creating flight simulations, understanding parameters, accessing results, and utilizing advanced features.
Key changes:
- Added a new Flight class usage documentation page covering simulation creation, parameters, results access, plotting, and advanced features
- Updated the main user guide index to include the new Flight documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/user/index.rst | Added Flight documentation entry to the user guide table of contents |
| docs/user/flight.rst | New comprehensive Flight class documentation with examples, parameter explanations, and usage patterns |
|
here is a preview of the new flight docs page: |
Gui-FernandesBR
force-pushed
the
docs/flight-page
branch
from
ab77bda to
a9ba19c
Compare
DOC: improve flight docs page documentation DEV: Add Flight class usage documentation entry to CHANGELOG
…ocketPy into docs/flight-page
MateusStano
reviewed
Jul 29, 2025
|
@MateusStano , we are ready for a re-review! |
MateusStano
approved these changes
Aug 12, 2025
github-project-automation
bot
moved this from Backlog
to Next Version
in LibDev Roadmap
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.
Pull request type
Checklist
black rocketpy/ tests/) has passed locallypytest tests -m slow --runslow) have passed locallyCHANGELOG.mdhas been updated (if relevant)Current behavior
See issue #160
New behavior
Adds a new page to our documentation describing the usage of Flight class.
Breaking change
Additional information
Under construction. Suggestions are allowed.