Skip to content

DOC: correct Flight aerodynamic moment units - #1149

Merged
Gui-FernandesBR merged 1 commit into
RocketPy-Team:developfrom
ting-hong-shieh:codex/doc-flight-moment-units
Aug 14, 2026
Merged

DOC: correct Flight aerodynamic moment units#1149
Gui-FernandesBR merged 1 commit into
RocketPy-Team:developfrom
ting-hong-shieh:codex/doc-flight-moment-units

Conversation

@ting-hong-shieh

Copy link
Copy Markdown

Pull request type

  • Code changes
  • Code maintenance
  • ReadMe, Docs and GitHub updates
  • Other

Current behavior

The Flight.M1, Flight.M2, and Flight.M3 docstrings describe aerodynamic moments as Newtons (N), which is a force unit. Their Function output labels and the surrounding Flight documentation already identify these values as moments.

At merge base cb6106a717207dd8fc2dfe1446d80ff75022f21b, all three docstrings say:

Expressed in Newtons (N).

New behavior

At head 3ac68cdf16e65bd070c608d8b672dced429dbec6, the three docstrings say:

Expressed in Newton-metres (N·m).

No executable behavior changes.

Verification

  • Searched the source and user documentation for M1, M2, and M3 unit descriptions; these were the three force-unit references.
  • .venv/bin/ruff check rocketpy/simulation/flight.py: passed
  • .venv/bin/ruff format --check rocketpy/simulation/flight.py: passed
  • git diff --check: passed
  • Sphinx 8.1.3 started with -W --keep-going and read the documentation until the first notebook conversion. The local build could not continue because Pandoc is not installed; no Sphinx warning from this change was reported before that external-tool failure.

The GitHub documentation job remains the complete Sphinx verification.

Environment: RocketPy 1.13.0; Python 3.12.6; Ruff 0.16.3; macOS 26.5.2 arm64.

Breaking change

  • No

@codecov

codecov Bot commented Aug 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.29%. Comparing base (e0ff281) to head (3ac68cd).
⚠️ Report is 53 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1149      +/-   ##
===========================================
+ Coverage    82.18%   83.29%   +1.11%     
===========================================
  Files          122      130       +8     
  Lines        16355    17080     +725     
===========================================
+ Hits         13441    14227     +786     
+ Misses        2914     2853      -61     

☔ View full report in Codecov by Harness.
📢 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.

@ting-hong-shieh
ting-hong-shieh marked this pull request as ready for review August 14, 2026 02:34
@ting-hong-shieh
ting-hong-shieh requested a review from a team as a code owner August 14, 2026 02:34

@Gui-FernandesBR Gui-FernandesBR left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch!

@Gui-FernandesBR
Gui-FernandesBR merged commit 6a6910d into RocketPy-Team:develop Aug 14, 2026
19 checks passed
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.

2 participants