Skip to content

Conversation

@Gui-FernandesBR
Copy link
Member

Several errors broke the documentations. I"m trying to fix it with this PR.

@Gui-FernandesBR Gui-FernandesBR requested a review from a team as a code owner December 4, 2025 23:23
Copy link

Copilot AI left a 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_moments method to better follow NumPy style guide conventions
  • Added FlightComparator to public API exports with an __all__ definition in rocketpy/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

@Gui-FernandesBR Gui-FernandesBR merged commit 05d7f90 into develop Dec 15, 2025
7 checks passed
@Gui-FernandesBR Gui-FernandesBR deleted the docs/fixes branch December 15, 2025 01:06
@codecov
Copy link

codecov bot commented Dec 15, 2025

Codecov Report

❌ Patch coverage is 97.91667% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 81.08%. Comparing base (9cf3dd4) to head (ed75036).
⚠️ Report is 25 commits behind head on develop.

Files with missing lines Patch % Lines
rocketpy/simulation/flight.py 97.50% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants