-
-
Notifications
You must be signed in to change notification settings - Fork 142
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
Conversation
Readthedocs can not build because of the |
Well noted, I will fix that. |
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. |
There was a problem hiding this 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
Co-authored-by: MateusStano <69485049+MateusStano@users.noreply.github.com>
Co-authored-by: MateusStano <69485049+MateusStano@users.noreply.github.com>
Pull request type
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 theFlight.export_data
.Breaking change