Skip to content

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

Merged
jaraco merged 2 commits into
pypa:masterfrom
sgaist:add_markdown_to_possible_readmes
Sep 3, 2017
Merged

Improve README file list handling and add Markdown to the current list#1133
jaraco merged 2 commits into
pypa:masterfrom
sgaist:add_markdown_to_possible_readmes

Conversation

@sgaist

@sgaist sgaist commented Aug 21, 2017

Copy link
Copy Markdown
Contributor

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

jaraco commented Aug 26, 2017

Copy link
Copy Markdown
Member

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

sgaist commented Aug 31, 2017

Copy link
Copy Markdown
Contributor Author

Sure, I'll modify it.

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

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 add_markdown_to_possible_readmes branch from 2f0c966 to 500bb9a Compare August 31, 2017 22:17
@jaraco jaraco merged commit 10bcb50 into pypa:master Sep 3, 2017
@jaraco jaraco mentioned this pull request Sep 3, 2017
@sgaist sgaist deleted the add_markdown_to_possible_readmes branch September 5, 2017 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants