bpo-11913: Add README.rst to the distutils standard READMEs #563
Conversation
|
@kirbyfan64, thanks for your PR! By analyzing the history of the files in this pull request, we identified @merwok, @collinw, @jaraco, @birkenfeld and @freddrake to be potential reviewers. |
|
Does PyPI display |
|
@nedbat No. |
|
I agree with @nedbat about leaving out I don't see an issue on bpo for this; am I missing something? |
|
There are efforts on the Warehouse side (discussed on various PyPA bug trackers and mailing lists) to support markdown; let’s not change the client docs before the server* actually supports it.
|
|
@nedbat @freddrake @merwok Fixed. |
refi64
changed the title
|
LGTM, but @merwok should weigh in. |
Lib/distutils/command/sdist.py
Outdated
| @@ -96,7 +96,7 @@ def checking_metadata(self): | |||
|
|
|||
| sub_commands = [('check', checking_metadata)] | |||
|
|
|||
| READMES = 'README', 'README.txt' | |||
| READMES = 'README', 'README.txt', 'README.rst' | |||
There was a problem hiding this comment.
nitpick: I prefer an explicit tuple: ('README', 'README.txt', 'README.rst')
|
@Haypo Done. |
| called your setup script), and :file:`setup.cfg` | ||
| * Any of the standard README files (:file:`README`, :file:`README.txt`, | ||
| or :file:`README.rst`), :file:`setup.py` (or whatever you called your setup | ||
| script), and :file:`setup.cfg`. |
There was a problem hiding this comment.
You should document the change using a ".. versionchanged:: 3.7 xx" markup, see a few lines below.
There was a problem hiding this comment.
Also, there should be an issue for this on bugs.python.org and the PR title should reference that issue. It looks like this is a duplicate of bpo-11913 which was originally closed as "wont fix". It could be reopened and used to track this.
refi64
changed the title
refi64
force-pushed
the
distutils-readme
branch
from
34a627f
to
85ef3b4
Compare
|
@Haypo Done. (I would personally think this isn't worthy of going in |
|
This is a user-visible usability improvement, so it deserves a mention in whatsnew. I believe the section would be «improved modules». I don’t think there is markup to reference PRs, but you referencing the bpo bug is all that’s needed. |
|
Please fix the conflict on Misc/NEWS (rebase your change). |
|
@kirbyfan64: Oh, and see also latest @merwok comment. |
refi64
force-pushed
the
distutils-readme
branch
from
85ef3b4
to
e53d078
Compare
|
@Haypo Done. |
|
I fixed a conflict in whatsnew/3.7.rst |
refi64
force-pushed
the
distutils-readme
branch
from
fa7b9c2
to
ef293bd
Compare
|
Rebased again onto the latest news and whatsnew. |
refi64
force-pushed
the
distutils-readme
branch
from
ef293bd
to
cc6ddb9
Compare
|
Rebased...again... |
|
I merged your enhancement. Thanks. I didn't notice that README.rst wasn't included by distutils. Maybe because it's included in setuptools, and I now always use setuptools?
I'm sorry about that, but we are working on a solution for this very annoying file (Misc/NEWS): |
Bumps [redis](https://github.com/redis/redis-py) from 4.3.3 to 4.3.4. - [Release notes](https://github.com/redis/redis-py/releases) - [Changelog](https://github.com/redis/redis-py/blob/master/CHANGES) - [Commits](redis/redis-py@v4.3.3...v4.3.4) --- updated-dependencies: - dependency-name: redis dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
No description provided.