Skip to content

Commit 877e47f

Browse files
docs: Add documentation comment to scrub_list (#2769)
The new comment explains what the method does, allowing developers to more quickly understand the method's purpose.
1 parent 69d2be1 commit 877e47f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

sentry_sdk/scrubber.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,12 @@ def __init__(self, denylist=None, recursive=False):
6767

6868
def scrub_list(self, lst):
6969
# type: (List[Any]) -> None
70+
"""
71+
If a list is passed to this method, the method recursively searches the list and any
72+
nested lists for any dictionaries. The method calls scrub_dict on all dictionaries
73+
it finds.
74+
If the parameter passed to this method is not a list, the method does nothing.
75+
"""
7076
if not isinstance(lst, list):
7177
return
7278

0 commit comments

Comments
 (0)