fix: code comment

InfluxCommunity · Aug 28, 2023 · 8e20cdf · 8e20cdf
1 parent 7815259
commit 8e20cdf
Showing 1 changed file with 12 additions and 10 deletions.
diff --git a/influxdb3/client.go b/influxdb3/client.go
@@ -111,13 +111,15 @@ func New(config ClientConfig) (*Client, error) {
 }
 
 // NewFromConnectionString creates new Client from the specified connection string.
-// Example: `https://us-east-1-1.aws.cloud2.influxdata.com/?token=my-token&database=my-database`.
+// Parameters:
+//   - connectionString: connection string in URL format.
 // Supported query parameters:
-//   - `token` (required)
-//   - `organization`
-//   - `database`
-//   - `precision`
-//   - `gzipThreshold`
+//   - token (required)
+//   - organization
+//   - database
+//   - precision
+//   - gzipThreshold
+// Example: https://us-east-1-1.aws.cloud2.influxdata.com/?token=my-token&database=my-database
 func NewFromConnectionString(connectionString string) (*Client, error) {
 	cfg := ClientConfig{}
 	err := cfg.parse(connectionString)
@@ -129,10 +131,10 @@ func NewFromConnectionString(connectionString string) (*Client, error) {
 
 // NewFromEnv creates new Client instance from environment variables.
 // Supported variables:
-//   - `INFLUX_HOST` (required)
-//   - `INFLUX_TOKEN` (required)
-//   - `INFLUX_ORG`
-//   - `INFLUX_DATABASE`
+//   - INFLUX_HOST (required)
+//   - INFLUX_TOKEN (required)
+//   - INFLUX_ORG
+//   - INFLUX_DATABASE
 func NewFromEnv() (*Client, error) {
 	cfg := ClientConfig{}
 	err := cfg.env()