docs: Update test docstrings to follow RocketPy NumPy style guidelines#2
Merged
aZira371 merged 2 commits intoenh/3-dof-simulationfrom Nov 27, 2025
Merged
Conversation
Co-authored-by: aZira371 <99824864+aZira371@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update test files with docstrings per RocketPy guidelines
docs: Update test docstrings to follow RocketPy NumPy style guidelines
Nov 27, 2025
aZira371
approved these changes
Nov 27, 2025
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.
Pull request type
Checklist
black rocketpy/ tests/) has passed locallypytest tests -m slow --runslow) have passed locallyCurrent behavior
Test files created in PR RocketPy-Team#745 (3-DOF simulation feature) lack proper docstrings following RocketPy's NumPy-style documentation guidelines.
New behavior
Added NumPy-style docstrings to all test functions and fixtures in the newly created test files:
tests/unit/motors/test_point_mass_motor.py- Added docstrings to 5 test functions explaining what each test validatestests/unit/rocket/test_point_mass_rocket.py- Added docstrings to 3 test functions with descriptive summariestests/unit/simulation/test_flight_3dof.py- Enhanced docstrings for 2 fixtures and 4 test functions with properParametersandReturnssectionsExample docstring format used:
Breaking change
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.