Whitelist path documentation #328
Merged
Conversation
This file contains 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
It may be unclear to users that the whitelist is configurable by adding it to the `paths` variable in pyproject.toml (see #327). Adding it into the example configuration should make this more obvious.
It may be unclear to users that the whitelist is configurable by adding it to the `paths` variable in pyproject.toml (see #327). Adding an explicit note about this should help.
|
Thanks for the PR! I think having the extended example is enough, so I removed the extra text. |
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.
Description
Adds explicit documentation regarding how the whitelist file can be configured in the
pyproject.toml.Related Issue
Issue #327
Checklist:
I have added an entry in CHANGELOG.md. N/AI have added or adapted tests to cover my changes. N/Atox -e fix-styleto format my code and checked the result withtox -e style.