The project has README.md and README.rst files. Updating the readme requires making sure you change both files. Remove one.
morenoh149
All 5 comments
I guess the README.rst was for PyPI and the README.md for GitHub.
As far as I know GitHub now understands README.rst as well, and on the other hand PyPI now also understands README.md when you set long_description_content_type="text/markdown" in setup.py. So in fact one of them should be removed, but make sure everything still looks nice in both GitHub and PyPI.
Cito
on 8 Mar 2019
Is anyone working on this? If not i can start with this minor change or update.
vreddhi
on 26 Mar 2019
@vreddhi go for it. It's a toss up. I prefer markdown.
morenoh149
on 26 Mar 2019
I agree, let me checkout a branch and remove the restructuredtext, as it is more safe to have markdown, and we need not have redundant data in two places.
I say it is more safe because of additional guideline given in pypi documentation regarding restructuredtext.
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup
vreddhi
on 27 Mar 2019
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
![stale[bot] picture](https://avatars3.githubusercontent.com/in/1724?v=4&s=40)
stale[bot]
on 3 Aug 2019
Related issues
BossGrand
路
4Comments
ghoshabhi
路
3Comments
romaia
路
3Comments
jloveric
路
4Comments
japrogramer
路
4Comments
Most helpful comment
I agree, let me checkout a branch and remove the restructuredtext, as it is more safe to have markdown, and we need not have redundant data in two places.
I say it is more safe because of additional guideline given in pypi documentation regarding restructuredtext.
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup