Skip to content

Commit

Permalink
Add warning on support of attr: directive
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ajnelson-nist committed Dec 21, 2020
1 parent 8c1f843 commit 8cd8645
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions source/guides/single-sourcing-package-version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ number of your project:
analysis so that ``attr:`` can function without having to import any of
the package's dependencies.

Also, please be aware that declarative config indicators, including the
``attr:`` directive, are not supported in parameters to setup.py.

#. Use an external build tool that either manages updating both locations, or
offers an API that both locations can use.
Expand Down

0 comments on commit 8cd8645

Please sign in to comment.