Conversation
Owner
|
Thank you, that's very nice! I will keep it open for the moment, because I am in the middle of transferring the documentation to a new platform (branch |
xoolive
added a commit
that referenced
this pull request
Sep 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/user_guide/own_data.rst has been a title-only stub since it was created in February 2022. This fills it in.
The page now lists the minimum column set with units, and walks through loading a CSV whose columns don't match — renaming, and converting the timestamp to a timezone-aware datetime.
Issue #312 describes a user with trajectory data in a CSV who couldn't work out from the docs how to load it. What makes this worth documenting is that Flight and Traffic wrap a DataFrame without validating or renaming anything, so mismatched column names don't fail at construction — they fail later, in whichever method expected the column. That's a hard first experience to debug, and loading your own data is one of the first things a new user tries.
I used .. code-block:: python rather than .. jupyter-execute:: as other user guide pages do, because I couldn't build the docs locally to verify a runnable block would pass. Happy to convert it if you'd prefer consistency.
First contribution here. I didn't find a CONTRIBUTING file, so I followed the conventions in the existing docs/user_guide/ pages — let me know if you'd like it structured differently.
Closes #312