Fix copy-paste error in -w/--whitelist-regex docs#190
Open
TejasAmle wants to merge 1 commit into
Open
Conversation
The description for -w/--whitelist-regex incorrectly referenced -r/--ignore-regex in the 'Multiple invocations supported' note. Updated to reference -w/--whitelist-regex as shown in the CLI source and README.
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
1 participant
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.
What
Fix a copy-paste error in
docs/index.rstwhere the-w/--whitelist-regexoption description incorrectly referenced-r/--ignore-regexin its "Multiple invocations supported" note.Before:
After:
Why
The
-w/--whitelist-regexentry was clearly copied from the-r/--ignore-regexentry just above it and the flag reference was never updated. This is confirmed by the CLI source insrc/interrogate/cli.py(line 203) andREADME.rst, both of which correctly show-w/--whitelist-regexfor this option.How verified
Cross-referenced against
src/interrogate/cli.pyandREADME.rst.