Add usage examples for clean() and Cleaner arguments#120
Merged
messense merged 1 commit intomessense:mainfrom Mar 25, 2026
Merged
Add usage examples for clean() and Cleaner arguments#120messense merged 1 commit intomessense:mainfrom
messense merged 1 commit intomessense:mainfrom
Conversation
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 clean() docstring already had examples for the basic case, attribute_filter and link_rel, but the remaining parameters were only documented through :param: descriptions inherited from the Cleaner class. A few of them — especially attributes (the wildcard key), tag_attribute_values, and allowed_classes — have fairly unintuitive signatures that are hard to figure out from the type annotation alone.
I added pycon examples for the parameters that seemed least obvious and grouped the related ones (tag_attribute_values / set_tag_attribute_values) together. Also threw in a quick usage snippet for the Cleaner class since its docstring had zero examples.
Closes #70