docs: Add documentation comment to scrub_list#2769
Merged
szokeasaurusrex merged 3 commits intomasterfrom Feb 27, 2024
Merged
Conversation
The new name indicates that the method is private API and that it is intended to only be called in the recursive scrubbing case
scrub_list to _scrub_list_recursivescrub_list to scrub_list_recursive
scrub_list to scrub_list_recursivescrub_list
sentrivana
approved these changes
Feb 27, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The new comment explains what the method does, allowing developers to more quickly understand the method's purpose.