-
Notifications
You must be signed in to change notification settings - Fork 287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace description-file setuptools metadata key with description_file in setup.cfg #1017
Replace description-file setuptools metadata key with description_file in setup.cfg #1017
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1017 +/- ##
=======================================
Coverage 85.55% 85.55%
=======================================
Files 192 192
Lines 18317 18317
Branches 2056 2056
=======================================
Hits 15672 15672
Misses 2119 2119
Partials 526 526
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
I can't find documentation, other than this, which doesn't mention the deprecation reported in the warning. https://docs.openstack.org/pbr/latest/user/features.html - our tests have all passed, including making wheels for py27, so it seems fine! |
See pypa/setuptools#2588 and pypa/setuptools#1608 for more information on this warning. |
Thanks for the links. Looks like setuptools' maintainers decided to deviate from PEP508 which states that dashes and underscores are supposed to be equivalent. |
Are the other hyphenated fields ok? |
(meaning: will we have to change the rest to underscores as well?) |
Looking through the file, it looks like a mix of hyphens and underscores. This seems fine, we can fix them as they come up. Thanks! |
The PEP isn't clear on that, so they decided one something, which is this warning.
This warning should only apply to sections owned by setuptools/distutils, see pypa/setuptools#2595 (comment). So the PR I linked was a little problematic, which was fixed in pypa/setuptools#2600. So the other sections not owned by setuptools/distutils are fine. |
Summary
Latest
setuptools
prints a deprecation warning as follows:So this PR simply replaces
description-file
withdescription_file
.