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: Generic Surface #690

Merged
merged 11 commits into from
Sep 14, 2024
Merged

DOC: Generic Surface #690

merged 11 commits into from
Sep 14, 2024

Conversation

MateusStano
Copy link
Member

Pull request type

  • ReadMe, Docs and GitHub updates

Description

  • Added docs page describing usage of the GenericSurface classes

  • Added GenericSurface and LinearGenericSurface doc strings to reference docs

rocket = Rocket(
...
)
rocket.add_generic_surface(generic_surface, position=(0,0,0))
Copy link
Member

Choose a reason for hiding this comment

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

Mmmmmm do we really need a add_generic_surface method? Why not using the very same add_surfaces method?

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.

There's a file mistakenlly added to the tests/fixtures/motor folder, can you please delete it?

Btw your new documentation is really cool, I think we have been mastering sphinx documentation on RocketPy for a while now.

Base automatically changed from enh/generic-surfaces-pylint to enh/generic-surfaces September 14, 2024 22:12
@MateusStano MateusStano merged commit 2f44b7e into enh/generic-surfaces Sep 14, 2024
4 of 5 checks passed
@MateusStano MateusStano deleted the doc/generic-surface branch September 14, 2024 22:28
Copy link

codecov bot commented Sep 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.89%. Comparing base (4815fc1) to head (78fb46c).
Report is 12 commits behind head on enh/generic-surfaces.

Additional details and impacted files
@@                   Coverage Diff                    @@
##           enh/generic-surfaces     #690      +/-   ##
========================================================
+ Coverage                 74.85%   74.89%   +0.04%     
========================================================
  Files                        98       98              
  Lines                     11012    11006       -6     
========================================================
  Hits                       8243     8243              
+ Misses                     2769     2763       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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