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

Improve README file list handling and add Markdown to the current list #1133

Merged
merged 2 commits into from Sep 3, 2017

Conversation

Projects
None yet
2 participants
@sgaist
Contributor

sgaist commented Aug 21, 2017

Markdown is a widely used format to write README files and documentation.

This patch aims to simplify adding new formats and at the same time adds that one to the list.

@jaraco

This comment has been minimized.

Member

jaraco commented Aug 26, 2017

I think this project has rejected this change before, probably because adding this change gives the impression that .md is supported, but there are several aspects of the ecosystem in which .md is poorly supported. Searching for it, though, I can find no references. That presumption is changing, however (as you can see in other PRs that are pending/WIP with setuptools and others).

I'd prefer to get away from special-casing the README, but as long as that's what distutils does, we should probably extend the behavior to match users' expectations.

Can you add an entry to CHANGES.txt to inform users of how their expectations should change with this change?

@sgaist

This comment has been minimized.

Contributor

sgaist commented Aug 31, 2017

Sure, I'll modify it.

Do you think that it would be possible to update distutils to improve the situation ?

Improve README file list handling and add Markdown to the current list
Markdown is a widely used format to write README files and
documentation. This patch aims to simplify adding new formats and at
the same time adds that one to the list.

@sgaist sgaist force-pushed the sgaist:add_markdown_to_possible_readmes branch from 2f0c966 to 500bb9a Aug 31, 2017

@jaraco jaraco merged commit 10bcb50 into pypa:master Sep 3, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@jaraco jaraco referenced this pull request Sep 3, 2017

Merged

Fix Python 2.6 support #1141

@sgaist sgaist deleted the sgaist:add_markdown_to_possible_readmes branch Sep 5, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment