Repository navigation
Link the export formats guide from the README - #1
Merged
Merged
Conversation
The docs site gains a page on the three formats and the six datasets. It also shows how to read the files in pandas, DuckDB and R, with tested examples. The README now links it from the file contents section and from the links list. The page is published from livetennisapi/openapi. The link works once that change is merged and the docs are published again.
The README said the API key stays out of your shell history. The line above it sets the API key with an export command, which a shell can record. The README now says the API key is never part of the export command.
The module docstring said the API key stays out of shell history. That depends on how the user sets the variable. What holds is that it is not in the export command or its process arguments.
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.
Links the new export formats guide from the README, in the file contents section and in the links list.
The guide is https://docs.livetennisapi.com/export-formats.html. It says when each format fits and shows how to read the files in pandas, DuckDB and R.
It also corrects one sentence. The README said the API key stays out of your shell history, yet the line above sets it with an
exportcommand. It now says the API key is never part of the export command.Merge order
The page is added by livetennisapi/openapi#21 and is not live yet. Until that PR is merged and the docs are published again, the link answers 404. Merge this one after the page is up.
The README is also the PyPI project description. PyPI shows the new link only after the next release.
Checks run
sh scripts/truthcheck.sh: OK