Skip to content

Conversation

@phmbressan
Copy link
Collaborator

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Docs have been reviewed and added / updated
  • CHANGELOG.md has been updated (if relevant)

Current behavior

A typo in parameter name is causing an error on docs build. Furthermore, the documentation dependencies are fairly outdated.

New behavior

This PR updates all the documentation dependencies (locally make build-docs runs fine in Python 3.12) and fixes the parameter error.

Breaking change

  • Yes
  • No

@phmbressan phmbressan added this to the Release v1.X.0 milestone Sep 21, 2025
@phmbressan phmbressan self-assigned this Sep 21, 2025
@phmbressan phmbressan requested a review from a team as a code owner September 21, 2025 16:46
@phmbressan phmbressan added the Docs Docs and examples related label Sep 21, 2025
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR left a comment

Choose a reason for hiding this comment

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

Great fix.

But idk how we let these breaking changes to pass. Let's fix them in another PR.

Can you revert your code lines? Or maybe fix it here already

@github-project-automation github-project-automation bot moved this from Backlog to Next Version in LibDev Roadmap Sep 21, 2025
Copy link
Member

@Gui-FernandesBR Gui-FernandesBR left a comment

Choose a reason for hiding this comment

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

Am I crazy or what?

The variable was radius and apparently they got renamed to parachute_radius

@phmbressan
Copy link
Collaborator Author

Am I crazy or what?

The variable was radius and apparently they got renamed to parachute_radius

This variable only exists in the develop branch, it is new. Check out the current README.me from master below:

main = calisto.add_parachute(
    name="main",
    cd_s=10.0,
    trigger=800,  # ejection altitude in meters
    sampling_rate=105,
    lag=1.5,
    noise=(0, 8.3, 0.5),
)

drogue = calisto.add_parachute(
    name="drogue",
    cd_s=1.0,
    trigger="apogee",  # ejection at apogee
    sampling_rate=105,
    lag=1.5,
    noise=(0, 8.3, 0.5),
)

@phmbressan phmbressan merged commit f89834b into develop Sep 22, 2025
1 check passed
@phmbressan phmbressan deleted the doc/update-docs branch September 22, 2025 05:21
@github-project-automation github-project-automation bot moved this from Next Version to Closed in LibDev Roadmap Sep 22, 2025
uniKorqi422 added a commit to uniKorqi422/RocketPy that referenced this pull request Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Docs and examples related

Projects

Status: Closed

Development

Successfully merging this pull request may close these issues.

3 participants