Apply suggestions from code review

Co-authored-by: Johannes Scheuermann <johscheuer@users.noreply.github.com>
FoundationDB · Jul 15, 2024 · e756f4b · e756f4b
1 parent 2589c8d
commit e756f4b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/api/v1beta2/foundationdb_constants.go b/api/v1beta2/foundationdb_constants.go
@@ -37,7 +37,7 @@ const (
 		Config map constants
 	*/
 
-	// ClusterFileKey defines the key name in the ConfigMap whose value is the cluster file aka connection string
+	// ClusterFileKey defines the key name in the ConfigMap whose value is the content of the cluster file, the connection string.
 	ClusterFileKey = "cluster-file"
 
 	// CaFileKey defines the key name in the ConfigMap whose value contains the trusted certificate authority PEM

diff --git a/api/v1beta2/foundationdb_env_variables.go b/api/v1beta2/foundationdb_env_variables.go
@@ -21,17 +21,17 @@
 package v1beta2
 
 const (
-	// EnvNameDNSName specifies the DNS locality (identifies the pod when using DNS in lieu of IP)
+	// EnvNameDNSName specifies the DNS locality (identifies the pod when using DNS)
 	EnvNameDNSName = "FDB_DNS_NAME"
 
 	// EnvNameMachineID specifies the Machine ID locality. Also defines fault domain along with EnvNameZoneID
 	EnvNameMachineID = "FDB_MACHINE_ID"
 
-	// EnvNameZoneID specifies Zone ID locality. Also defines fault domain along with EnvNameMachineID.
+	// EnvNameZoneID specifies Zone ID locality.
 	// The current default value of EnvNameZoneID is the hostname
 	EnvNameZoneID = "FDB_ZONE_ID"
 
-	// EnvNameClusterFile specifies the path to the cluster file / file containing the connection string.
+	// EnvNameClusterFile specifies the path to the cluster file.
 	EnvNameClusterFile = "FDB_CLUSTER_FILE"
 
 	// EnvNameBinaryDir specifies the path of the FDB binary's directory