docs: Adding clarification that server URL needs to be base URL #189
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
sranka
approved these changes
Aug 17, 2020
CHANGELOG.md
Outdated
| @@ -1,3 +1,8 @@ | |||
| ## 2.1.0 [in progress] | |||
| ### Documentation | |||
| 1. [#189](https://github.com/influxdata/influxdb-client-go/pull/189) Added clarification that server URL has to the base URL to to API docs and all examples. | |||
There was a problem hiding this comment.
Suggested change
| 1. [#189](https://github.com/influxdata/influxdb-client-go/pull/189) Added clarification that server URL has to the base URL to to API docs and all examples. | |
| 1. [#189](https://github.com/influxdata/influxdb-client-go/pull/189) Added clarification that server URL has to be the base URL to API docs and all examples. |
README.md
Outdated
| @@ -71,18 +71,18 @@ import ( | |||
| ) | |||
|
|
|||
| func main() { | |||
| // create new client with default option for server url authenticate by token | |||
| // Create new client with default option for base server url authenticated by token | |||
There was a problem hiding this comment.
there is no default option for base server URL, the following comment would probably look better (all files):
Suggested change
| // Create new client with default option for base server url authenticated by token | |
| // Create a new client using an InfluxDB base URL and an authentication token |
| @@ -140,7 +140,7 @@ Client offers two ways of writing, non-blocking and blocking. | |||
|
|
|||
| ### Non-blocking write client | |||
| Non-blocking write client uses implicit batching. Data are asynchronously | |||
| written to the underlying buffer and they are automatically sent to a server when the size of the write buffer reaches the batch size, default 1000, or the flush interval, default 1s, times out. | |||
| written to the underlying buffer and they are automatically sent to a server when the size of the write buffer reaches the batch size, default 5000, or the flush interval, default 1s, times out. | |||
README.md
Outdated
| @@ -161,7 +161,8 @@ import ( | |||
| ) | |||
|
|
|||
| func main() { | |||
| // Create client and set batch size to 20 | |||
| // Create new client with default option for base server url authenticated by token | |||
There was a problem hiding this comment.
Suggested change
| // Create new client with default option for base server url authenticated by token | |
| // Create a new client using an InfluxDB base URL, an authentication token and custom options |
client.go
Outdated
| @@ -79,16 +79,18 @@ type clientImpl struct { | |||
| } | |||
|
|
|||
| // NewClient creates Client for connecting to given serverURL with provided authentication token, with the default options. | |||
| // Authentication token can be empty in case of connecting to newly installed InfluxDB server, which has not been set up yet. | |||
| // In such case Setup will set authentication token | |||
| // serverURL is the base URL, e.g. http://loocalhost:9999, | |||
There was a problem hiding this comment.
Suggested change
| // serverURL is the base URL, e.g. http://loocalhost:9999, | |
| // serverURL is the InfluxDB base URL, e.g. http://localhost:9999, |
vlastahajek
force-pushed
the
docs/base_url
branch
from
4bcaf13 to
095ca25
Compare
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 #182
Proposed Changes
Adding clarification that server URL needs to be base URL to client API docs and all examples in Readme and API docs
Checklist