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: add documentation for flight data export. #464

Merged
merged 4 commits into from
Nov 18, 2023
Merged

Conversation

phmbressan
Copy link
Collaborator

Pull request type

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

Current behavior

The documentation lacked proper description on simulation data export.

New behavior

A new section in the getting started page was added to cover the basics of using the Flight.export_data.

Breaking change

  • Yes
  • No

@phmbressan phmbressan added the Docs Docs and examples related label Nov 17, 2023
@phmbressan phmbressan added this to the Release v1.X.0 milestone Nov 17, 2023
@phmbressan phmbressan self-assigned this Nov 17, 2023
@MateusStano
Copy link
Member

Readthedocs can not build because of the pandas use in the .rst
I think you have to add it to the requirements file

@phmbressan
Copy link
Collaborator Author

Readthedocs can not build because of the pandas use in the .rst
I think you have to add it to the requirements file

Well noted, I will fix that.

@Gui-FernandesBR
Copy link
Member

Readthedocs can not build because of the pandas use in the .rst
I think you have to add it to the requirements file

Installing pandas for just a single operation could desnecessarily slow down the build time since pandas is a bit large. I would first check if numpy can't solve the same problem, as we already have numpy being installed when building the docs (Prolly not, but worths the shot.)

Installing pandas os not end of the world anyway.

Copy link
Member

@MateusStano MateusStano left a comment

Choose a reason for hiding this comment

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

Everything good! Just made a few suggestion

The first simulation page is getting very over filled, specially with the whole all_info() running. Something for us to change in the future

Also somewhere in the exporting data section there definitely should be a See Also block leading to the Function Class Usage, but this shoud be done in #465

docs/user/first_simulation.rst Show resolved Hide resolved
docs/user/first_simulation.rst Outdated Show resolved Hide resolved
phmbressan and others added 2 commits November 17, 2023 21:54
Co-authored-by: MateusStano <69485049+MateusStano@users.noreply.github.com>
Co-authored-by: MateusStano <69485049+MateusStano@users.noreply.github.com>
@MateusStano MateusStano merged commit 84b126e into develop Nov 18, 2023
2 checks passed
@MateusStano MateusStano deleted the doc/data-export branch November 18, 2023 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

None yet

3 participants