docs(kinematic): document units for all WRAP accessors - #70
Open
TommyC81 wants to merge 1 commit into
Open
Conversation
Document units for all WRAP kinematic accessors (km, m/s, m/s^2). Docstrings only; zero logic change.
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
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.
What & why
The
WRAPkinematic accessors inopenap/kinematic.pyreturn values in a mix of km, m/s, and m/s², but onlyclimb_range()documented its unit. Every other accessor had a unit-less docstring (e.g."Get takeoff distance."), so a consumer assuming meters / knots / ft·min⁻¹ silently gets a value off by 10–1000×.The WRAP data is internally consistent — this is a documentation fix, not a computation change. Closes #69.
Changes (docstrings only — zero logic change)
climb_range()(in km)style.cruise_max_alt,cruise_max_mach,cruise_mean_vcas).landing_distance()typo:"breaking"→"braking".descent_cross_alt_concas()was a verbatim copy of…conmach(); now reads"from constant CAS to post-constant-CAS descent", matching thedescent_vs_post_concas()naming already in the file.Two minor rewordings beyond a pure unit-add, flagged for review:
climb_const_mach/descent_const_mach:"speed during constant Mach …"→"Mach number during constant Mach …"(Mach is dimensionless; there is no unit to append).descent_cross_alt_concas:"from constant CAS to post-constant-CAS descent"— the constant-CAS phase ends at the lower crossover (de_h_cas_const≈ 5.7 km), below which the descent decelerates toward approach. Verified against the three descent vertical-rate variables (de_vs_avg_mach_const/…cas_const/…after_cas) which encode the three-phase structure, and against thedescent_vs_post_concas()method name.Verification
No return values, signatures, or imports are touched. Confirmed by stripping all docstrings and diffing the remaining code — original and working copy are identical except for blank lines where docstrings were added to the three previously-bare functions.