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: Update CSV Header Related Docs #495

Merged
merged 5 commits into from
Dec 3, 2023
Merged

Conversation

MateusStano
Copy link
Member

Pull request type

  • Code maintenance (refactoring, formatting, tests)

Checklist

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

Current behavior

Docs related to reading files mentioned that the files must contain no headers

New behavior

Now those docs mention that the files can contain headers

Breaking change

  • Yes
  • No

Copy link

codecov bot commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (beb22ab) 71.05% compared to head (94eded4) 71.14%.
Report is 27 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #495      +/-   ##
===========================================
+ Coverage    71.05%   71.14%   +0.08%     
===========================================
  Files           55       55              
  Lines         9262     9276      +14     
===========================================
+ Hits          6581     6599      +18     
+ Misses        2681     2677       -4     
Flag Coverage Δ
unittests 71.14% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

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.

This Looks Good To Me

docs/user/rocket.rst Outdated Show resolved Hide resolved
@MateusStano MateusStano requested a review from a team as a code owner December 2, 2023 14:51
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.

All good.

@@ -37,6 +37,7 @@ straightforward as possible.
### Changed

- ENH: Function Reverse Arithmetic Priority [#488](https://github.com/RocketPy-Team/RocketPy/pull/488)
- DOC: Update Header Related Docs
Copy link
Member

Choose a reason for hiding this comment

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

@MateusStano you don't need to include this in the change log. From the user's perspective, it's irrelevant.

@Gui-FernandesBR Gui-FernandesBR merged commit a964662 into develop Dec 3, 2023
13 checks passed
@Gui-FernandesBR Gui-FernandesBR deleted the doc/update-header-docs branch December 3, 2023 01:38
@phmbressan phmbressan mentioned this pull request Dec 19, 2023
7 tasks
@Gui-FernandesBR Gui-FernandesBR changed the title DOC: Update Header Related Docs DOC: Update CSV Header Related Docs Feb 8, 2024
@Gui-FernandesBR Gui-FernandesBR added Function Everything related to the Function class Docs Docs and examples related labels Feb 12, 2024
@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related Function Everything related to the Function class
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

4 participants