docs(anonymizer): drop the undefined NONE member from the ConflictResolutionStrategy docstring - #2247
Open
L4XB wants to merge 1 commit into
Open
Conversation
…olutionStrategy docstring
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Documentation-only change that corrects an objectively incorrect enum docstring without affecting behavior.
Pull request overview
This PR corrects the public documentation for ConflictResolutionStrategy in presidio-anonymizer by removing a docstring entry for a non-existent enum member (NONE), preventing users from following docs into an AttributeError.
Changes:
- Removed the undocumented/undefined
NONE“No conflict resolution” entry from theConflictResolutionStrategyclass docstring. - Left runtime behavior unchanged (documentation-only fix), keeping the docstring aligned with the enum’s actual members.
File summaries
| File | Description |
|---|---|
| presidio-anonymizer/presidio_anonymizer/entities/conflict_resolution_strategy.py | Removes the incorrect NONE docstring entry so the enum documentation matches the implemented members. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
Fixes #2241.
The
ConflictResolutionStrategydocstring listed aNONEmember ("No conflict resolution will be performed") that the enum does not define, andAnonymizerEnginehas no opt-out path either: the merge and conflict passes in_remove_conflicts_and_get_text_manipulation_dataalways run and onlyREMOVE_INTERSECTIONSis gated. A caller following the docstring getsAttributeError: NONE.Change
Documentation only: the
NONEline is removed from the class docstring so it describes the two members that exist. No behaviour change; adding a real no-op strategy would be a separate behaviour decision, as the issue notes.