Improved example and fixed comments #5721
Closed
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
MeelahMe
changed the title
MeelahMe
changed the title
jstirnaman
requested changes
Dec 23, 2024
| token=f"DATABASE_TOKEN", | ||
| write_client_options=wco) as client: | ||
|
|
||
| #### Example: Writing and querying data |
There was a problem hiding this comment.
Thanks for adding this description. The list_code_example should only contain a code block, not Markdown content. I think we should move the description inside the python code block as python comments.
| table = client.query( | ||
| '''SELECT * | ||
| FROM home | ||
| WHERE time >= now() - INTERVAL '90 days' | ||
| ORDER BY time''') | ||
| ``` | ||
| This script assumes the client object is correctly configured with your database name, token, and host URL. After running the query, table will contain the queried data formatted as a PyArrow table. |
There was a problem hiding this comment.
Suggested change
| This script assumes the client object is correctly configured with your database name, token, and host URL. After running the query, table will contain the queried data formatted as a PyArrow table. | |
| This script assumes the client object is correctly configured with your database name, token, and host URL. After the script runs, the table variable contains the data formatted as a PyArrow table. |
This should also be a comment inside the code block.
| - [`influxdb_client_3.Point`](#class-point): a class for constructing a time series data | ||
| point | ||
| - [`influxdb_client_3.InfluxDBClient3`](#class-influxdbclient3): a class for interacting with InfluxDB. | ||
| - [`influxdb_client_3.Point`](#class-point): a class for constructing time a series data |
There was a problem hiding this comment.
Suggested change
| - [`influxdb_client_3.Point`](#class-point): a class for constructing time a series data | |
| - [`influxdb_client_3.Point`](#class-point): a class for constructing a time series data |
| - [`influxdb_client_3.InfluxDBClient3`](#class-influxdbclient3): a class for interacting with InfluxDB | ||
| - [`influxdb_client_3.Point`](#class-point): a class for constructing a time series data | ||
| point | ||
| - [`influxdb_client_3.InfluxDBClient3`](#class-influxdbclient3): a class for interacting with InfluxDB. |
There was a problem hiding this comment.
Thanks for catching the punctuation.
Just FYI, we'd typically do the reverse--we don't use periods if all the bullets are phrases (incomplete sentences). If at least one needs a complete sentence, then we'll end them all with periods to be consistent.
I'm not going to nitpick, though, as long as it looks consistent.
|
|
||
| # Write data in batches | ||
| ```python |
|
|
||
| #### Example: Writing and querying data | ||
|
|
||
| The following example demonstrates how to write sensor data into influxDB and retrieve data from the last 90 days for analysis. |
MeelahMe
changed the title
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.
Closes #
Describe your proposed changes here.
I went with the quick fix for the comments. Shortened the writing and query example. I also gave some more explanation for the example.
(if necessary)