-
-
Notifications
You must be signed in to change notification settings - Fork 235
DOCs: Fix documentation build #908
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
…atting in simulation files
b852bd8 to
e6a3d2b
Compare
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.
Pull request overview
This PR fixes documentation build errors by addressing import ordering, docstring formatting, and documentation file issues.
Key Changes
- Alphabetized imports across multiple files to comply with isort requirements
- Reformatted docstring for
calculate_rail_button_bending_momentsmethod to better follow NumPy style guide conventions - Added
FlightComparatorto public API exports with an__all__definition inrocketpy/simulation/__init__.py - Fixed indentation and file paths in RST documentation
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/unit/test_plots.py | Reordered imports alphabetically (matplotlib.animation before other imports) |
| rocketpy/simulation/flight.py | Moved calculate_rail_button_bending_moments method to better location and reformatted docstring to follow NumPy conventions with proper sections (Returns, Notes, Examples) and LaTeX math notation |
| rocketpy/simulation/init.py | Added FlightComparator import and defined __all__ list for explicit API exports |
| rocketpy/plots/tank_plots.py | Alphabetized imports within groups |
| rocketpy/plots/motor_plots.py | Alphabetized imports within groups |
| docs/user/flight_comparator.rst | Fixed indentation for code blocks and corrected file paths from ../data/calisto/ to ../data/rockets/calisto/, removed trailing whitespace |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #908 +/- ##
===========================================
+ Coverage 80.27% 81.08% +0.81%
===========================================
Files 104 107 +3
Lines 12769 13814 +1045
===========================================
+ Hits 10250 11201 +951
- Misses 2519 2613 +94 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Several errors broke the documentations. I"m trying to fix it with this PR.