Improve YARD doc for redacted_keys

bugsnag · Oct 5, 2021 · 383c808 · 383c808
1 parent 358f381
commit 383c808
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/lib/bugsnag/configuration.rb b/lib/bugsnag/configuration.rb
@@ -60,8 +60,13 @@ class Configuration
     # @return [Set<String, Regexp>]
     attr_accessor :meta_data_filters
 
-    # A list of keys that should be redacted from the report and breadcrumb
+    # A set of keys that should be redacted from the report and breadcrumb
     # metadata before sending them to Bugsnag
+    #
+    # When adding strings, keys that are equal to the string (ignoring case)
+    # will be redacted. When adding regular expressions, any keys which match
+    # the regular expression will be redacted
+    #
     # @return [Set<String, Regexp>]
     attr_accessor :redacted_keys