Skip to content

Conversation

@alessioimprota
Copy link
Contributor

Pull request type

  • Code changes (bugfix, features)
  • Code maintenance (refactoring, formatting, tests)
  • ReadMe, Docs and GitHub updates
  • Other

Current behavior

The existing documentation for the spherical_caps parameter currently states:

The spherical_caps parameter is optional and defaults to False. If set
to True, the tank will be defined as a cylinder with flat caps.
If True, the tank will have spherical caps.

New behavior

This should be updated to:

The spherical_caps parameter is optional and defaults to False. If set
to True, the tank will have spherical caps at the top and bottom with the
same radius as the cylindrical part. If set to False, the tank will
be defined as a cylinder with flat caps.

Breaking change

  • Yes
  • No

@alessioimprota alessioimprota requested a review from a team as a code owner November 9, 2024 23:08
@Gui-FernandesBR Gui-FernandesBR changed the base branch from master to develop November 10, 2024 00:31
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.

Nice catch!

@Gui-FernandesBR Gui-FernandesBR merged commit c512c40 into RocketPy-Team:develop Nov 10, 2024
@alessioimprota alessioimprota deleted the doc/spherical-caps-typo branch November 10, 2024 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Closed

Development

Successfully merging this pull request may close these issues.

2 participants