feature/tracing-credentials: minor docs refactoring

smartcontractkit · Nov 22, 2023 · bbebea7 · bbebea7
1 parent de6ad7a
commit bbebea7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/core/config/docs/core.toml b/core/config/docs/core.toml
@@ -592,7 +592,7 @@ CollectorTarget = 'localhost:4317' # Example
 NodeID = 'NodeID' # Example
 # SamplingRatio is the ratio of traces to sample for this node.
 SamplingRatio = 1.0 # Example
-# Mode is a string value. 'tls' or 'unencrypted' are the only values allowed. If set to 'unencrypted', TLSCertPath can be unset, meaning traces will be sent over plaintext to the collector.
+# Mode is a string value. `tls` or `unencrypted` are the only values allowed. If set to `unencrypted`, `TLSCertPath` can be unset, meaning traces will be sent over plaintext to the collector.
 Mode = 'tls' # Default
 # TLSCertPath is the file path to the TLS certificate used for secure communication with an OTEL Tracing Collector.
 TLSCertPath = '/path/to/cert.pem' # Example

diff --git a/core/config/toml/types.go b/core/config/toml/types.go
@@ -1546,7 +1546,7 @@ func isValidURI(uri string) bool {
 	return isValidLocalURI(uri)
 }
 
-// Validates uri is a valid local URI
+// isValidLocalURI returns true if uri is a valid local URI
 // External URIs (e.g. http://) are not valid local URIs, and will return false.
 func isValidLocalURI(uri string) bool {
 	parts := strings.Split(uri, ":")

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
@@ -1631,7 +1631,7 @@ SamplingRatio is the ratio of traces to sample for this node.
 ```toml
 Mode = 'tls' # Default
 ```
-Mode is a string value. 'tls' or 'unencrypted' are the only values allowed. If set to 'unencrypted', TLSCertPath can be unset, meaning traces will be sent over plaintext to the collector.
+Mode is a string value. `tls` or `unencrypted` are the only values allowed. If set to `unencrypted`, `TLSCertPath` can be unset, meaning traces will be sent over plaintext to the collector.
 
 ### TLSCertPath
 ```toml