Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: fix positions and coordinate system documentation page #454

Merged
merged 4 commits into from
Nov 7, 2023

Conversation

giovaniceotto
Copy link
Member

@giovaniceotto giovaniceotto commented Nov 7, 2023

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Docs have been reviewed and added / updated

Current behavior

The Positions and Coordinate Systems documentation page is an amazing resource that explains what is perhaps the most misunderstood part of RocketPy! However, even the greatest of resources can still be improved a bit.

Here are a couple of mistakes I found while reviewing it when working on another PR:

  • The section Example with Origin at the Center of Mass of the Positions and Coordinate Systems documentation page was actually just a copy of the section above.
  • The image contained in the section also had the + and - signs reversed.
  • The image nozzletcomb.png was not used and likely the result of a typo.
  • Some minor typos in the text.

New behavior

  • All issues listed above were fixed, in different commits.

Breaking change

  • No

Additional information

The reviewer may chose to review commit by commit in order to better understand the changes made.

RTD preview link: https://docs.rocketpy.org/en/doc-fix-positions-documentation/

@Gui-FernandesBR
Copy link
Member

#445

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.

Well done

@MateusStano MateusStano merged commit a8f5c10 into develop Nov 7, 2023
5 checks passed
@MateusStano MateusStano deleted the doc/fix-positions-documentation branch November 7, 2023 14:27
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Nov 20, 2023
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.

3 participants