docs: use brackets for hyphenated properties (#1005)

pinojs · Apr 9, 2021 · 84fa44b · 84fa44b
1 parent 9f77837
commit 84fa44b
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/redaction.md b/docs/redaction.md
@@ -3,11 +3,12 @@
 > Redaction is not supported in the browser [#670](https://github.com/pinojs/pino/issues/670)
 
 To redact sensitive information, supply paths to keys that hold sensitive data
-using the `redact` option:
+using the `redact` option. Note that paths which contain hypens need to use
+brackets in order to access the hyphenated property:
 
 ```js
 const logger = require('.')({
-  redact: ['key', 'path.to.key', 'stuff.thats[*].secret']
+  redact: ['key', 'path.to.key', 'stuff.thats[*].secret', 'path["with-hyphen"]']
 })
 
 logger.info({