Add warning on support of attr: directive #806
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
This patch is part of addressing setuptools issue 2492: pypa/setuptools#2492 The code in this Note block was found to not apply to equivalently-named features in setup.py. After discussion on the above issue, a project maintainer noted this behavior was expected. This patch adds documentation of expected behavior close to where it would be discovered by somebody who stumbled upon the attr: feature, but might not know the background on directives and setup.cfg vs. setup.py.
|
@jaraco I welcome any revisions to this patch. One thing I wasn't sure about is where there might be a statement of the class of features that confused me not being supported in setup.py. |
|
This looks fine to me. The note is in a particular corner of the docs (single-source version), so will be missed by others, but since you were the affected user, I'm guessing this is where the note would need to be to have the intended effect. Ultimately, guidance like this should probably go in the documentation for parameters to |
jaraco
approved these changes
Dec 23, 2020
webknjaz
reviewed
Feb 3, 2021
Thanks to @webknjaz for the style pointer. Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
di
approved these changes
Feb 3, 2021
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.
This patch is part of addressing setuptools issue 2492:
pypa/setuptools#2492
The code in this Note block was found to not apply to equivalently-named
features in setup.py. After discussion on the above issue, a project
maintainer noted this behavior was expected. This patch adds
documentation of expected behavior close to where it would be discovered
by somebody who stumbled upon the attr: feature, but might not know the
background on directives and setup.cfg vs. setup.py.