Skip to content

docs: Update test docstrings to follow RocketPy NumPy style guidelines#2

Merged
aZira371 merged 2 commits intoenh/3-dof-simulationfrom
copilot/update-test-docstrings
Nov 27, 2025
Merged

docs: Update test docstrings to follow RocketPy NumPy style guidelines#2
aZira371 merged 2 commits intoenh/3-dof-simulationfrom
copilot/update-test-docstrings

Conversation

Copy link

Copilot AI commented Nov 27, 2025

Pull request type

  • Code maintenance (refactoring, formatting, tests)

Checklist

  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest tests -m slow --runslow) have passed locally

Current 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 validates
  • tests/unit/rocket/test_point_mass_rocket.py - Added docstrings to 3 test functions with descriptive summaries
  • tests/unit/simulation/test_flight_3dof.py - Enhanced docstrings for 2 fixtures and 4 test functions with proper Parameters and Returns sections

Example docstring format used:

def test_structural_and_total_mass():
    """Tests structural and total mass properties of PointMassRocket.

    Verifies that the rocket's structural mass and total mass (including motor
    dry mass and propellant) are calculated correctly at time t=0.
    """

Breaking change

  • No
Original prompt

RocketPy-Team#745 update the newly created test files in this PR to write all docstrings according to rocketpy guielines


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

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
Copilot AI requested a review from aZira371 November 27, 2025 07:41
@aZira371 aZira371 marked this pull request as ready for review November 27, 2025 08:40
@aZira371 aZira371 merged commit 2e454c4 into enh/3-dof-simulation Nov 27, 2025
@aZira371 aZira371 deleted the copilot/update-test-docstrings branch November 27, 2025 08:42
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