Skip to content

DOC: Document angle-of-attack drag inputs - #1142

Open
ting-hong-shieh wants to merge 1 commit into
RocketPy-Team:developfrom
ting-hong-shieh:codex/doc-drag-angle-of-attack-767
Open

DOC: Document angle-of-attack drag inputs#1142
ting-hong-shieh wants to merge 1 commit into
RocketPy-Team:developfrom
ting-hong-shieh:codex/doc-drag-angle-of-attack-767

Conversation

@ting-hong-shieh

Copy link
Copy Markdown

Closes #767.

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Docs have been reviewed and updated
  • Ruff and Pylint pass locally
  • CHANGELOG.md — no action needed; an LLM workflow auto-updates it after merge

Current behavior

RocketPy already evaluates power_on_drag_7d and power_off_drag_7d with angle of attack, sideslip angle, Mach number, Reynolds number and body angular rates. Flight supplies the current flight-state values, but the public Rocket constructor documentation still says drag callables must depend on Mach number only.

New behavior

The constructor documentation now describes the supported constant, Mach-only and seven-variable drag inputs. The rocket usage guide adds:

  • the argument order and units for seven-variable callables;
  • an angle-of-attack and Mach example;
  • the header format for multivariable CSV tables; and
  • the distinction between the backward-compatible Mach-only attributes and the full *_drag_7d functions.

This changes documentation only; the drag calculation and public API remain unchanged.

Breaking change

  • No

Verification

  • pytest tests/unit/rocket/test_rocket.py -q — 60 passed
  • ruff check rocketpy/rocket/rocket.py
  • pylint rocketpy/rocket/rocket.py — 10.00/10
  • Sphinx warnings-as-errors build for the rocket usage page

@ting-hong-shieh
ting-hong-shieh marked this pull request as ready for review August 13, 2026 04:24
@ting-hong-shieh
ting-hong-shieh requested a review from a team as a code owner August 13, 2026 04:24
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.

1 participant