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: organize examples folder #429

Merged
merged 4 commits into from
Oct 7, 2023
Merged

Conversation

Gui-FernandesBR
Copy link
Member

Pull request type

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

Checklist

  • Tests for the changes have been added (if needed)
  • Docs have been reviewed and added / updated
  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest --runslow) have passed locally

Current behavior

We are running out of examples good enough to test our under-development features.

New behavior

I converted some old codes to jupyter notebooks (not the ideal, but will work fine for now), added then to the examples folder and also to the final documentation.

Breaking change

  • Yes
  • No

Additional information

  • The data folder should be the placeholder for data in general, not the tests folder. We may change this in the future
  • These new notebooks will help us to test some features and debug some flight simulations (hopefully). It helped me with the rocket drawing feature.

@Gui-FernandesBR Gui-FernandesBR added Docs Docs and examples related Git housekeeping Clean and organize our github labels Oct 7, 2023
@Gui-FernandesBR Gui-FernandesBR self-assigned this Oct 7, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Gui-FernandesBR
Copy link
Member Author

More flights were added here as a "positive side effect" of this PR:

image

@Gui-FernandesBR Gui-FernandesBR changed the base branch from enh/rocket-drawing to develop October 7, 2023 22:31
@Gui-FernandesBR Gui-FernandesBR merged commit 5b59e5d into develop Oct 7, 2023
10 checks passed
@Gui-FernandesBR Gui-FernandesBR deleted the doc/organize-examples branch October 7, 2023 22:32
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related Git housekeeping Clean and organize our github
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants