adjust log-on-startup docs

apache · Nov 25, 2023 · af5e254 · af5e254
1 parent ccce880
commit af5e254
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/src/main/paradox/logging.md b/docs/src/main/paradox/logging.md
@@ -119,11 +119,12 @@ pekko {
 }
 ```
 
-This config option is very good if you want to know what config settings are loaded by Pekko:
+This config option is useful if you want to know what config settings are loaded by Pekko:
 
 ```ruby
 pekko {
   # Log the complete configuration at INFO level when the actor system is started.
+  # This logging can include sensitive values.
   # This is useful when you are uncertain of what configuration is used.
   log-config-on-start = on
 }

diff --git a/docs/src/main/paradox/typed/logging.md b/docs/src/main/paradox/typed/logging.md
@@ -337,11 +337,12 @@ pekko {
 }
 ```
 
-This config option is very good if you want to know what config settings are loaded by Pekko:
+This config option is useful if you want to know what config settings are loaded by Pekko:
 
 ```
 pekko {
   # Log the complete configuration at INFO level when the actor system is started.
+  # This loggong can include sensitive values.
   # This is useful when you are uncertain of what configuration is used.
   log-config-on-start = on
 }