docs: correct definitions, broken link and grammar, capitalization, punctuation in python client documentation #2940
Conversation
This file contains 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
…e-streampipes-data-lake.ipynb
…-streampipes.ipynb
…easure.py The definitions of start- and end_date are reversed: end_date: This option restricts the queried data to be younger than the specified time. This means that only data after the specified timestamp will be retrieved. For example, if end_date is set to January 1, 2023, only data from January 2, 2023, or later would be retrieved, going forward in time. start_date: This option restricts the queried data to be older than the specified time. This means that only data before the specified timestamp will be retrieved. If start_date is set to January 1, 2023, only data before January 1, 2023, would be retrieved, i.e., December 31st, 2022, and earlier, going back in time. These definitions imply that the end date lies further in the past than the start_date. This is in fact wrong because it should be the other way around. Accordingly, the definitions have been corrected.
github-actions
bot
added
python
bossenti
requested changes
Jun 17, 2024
streampipes-client-python/docs/tutorials/1-introduction-to-streampipes-python-client.ipynb
Outdated
Show resolved
Hide resolved
…eampipes-python-client.ipynb Co-authored-by: Tim <[email protected]>
bossenti
approved these changes
Jun 18, 2024
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.
Purpose
This PR aims to improve the documentation for the python client by fixing minor typos, grammar mistakes as well as inaccurate parameter definitions.
Most important changes
start_dateandend_dateparameters of theget()method for measurements.Remarks
PR introduces (a) breaking change(s): no
PR introduces (a) deprecation(s): no