Fix comment: allowlist cannot be a plain string.

PiperOrigin-RevId: 660330096
google · Aug 19, 2024 · 126c1e4 · 126c1e4
1 parent 1507860
commit 126c1e4
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/gin/config.py b/gin/config.py
@@ -1762,7 +1762,7 @@ def some_configurable_function(param1, param2='a default value'):
   The decorator can be supplied with parameters to specify the configurable name
   or supply an allowlist/denylist:
 
-      @config.configurable('explicit_configurable_name', allowlist='param2')
+      @config.configurable('explicit_configurable_name', allowlist=['param2'])
       def some_configurable_function(param1, param2='a default value'):
         ...
 
@@ -1891,7 +1891,7 @@ def some_configurable_function(param1, param2='a default value'):
   The decorator can be supplied with parameters to specify the name used to
   register or supply an allowlist/denylist:
 
-      @config.register('explicit_name', allowlist='param2')
+      @config.register('explicit_name', allowlist=['param2'])
       def some_configurable_function(param1, param2='a default value'):
         ...