Skip to content

Fix RST errors in README.rst and test for errors#100

Merged
theskumar merged 1 commit intotheskumar:masterfrom
Flimm:fix-rst
Mar 7, 2018
Merged

Fix RST errors in README.rst and test for errors#100
theskumar merged 1 commit intotheskumar:masterfrom
Flimm:fix-rst

Conversation

@Flimm
Copy link
Contributor

@Flimm Flimm commented Mar 7, 2018

Having valid RST is important so that Pypi's web interface interprets the RST correctly and display long_description in a pretty format. Right now, the Pypi page looks pretty ugly:

https://pypi.python.org/pypi/python-dotenv

This pull request fixes the errors, and also adds a simple test to avoid this problem in the future.

The test is not run in Python 3.3 because of this bug:

https://sourceforge.net/p/docutils/bugs/270/

Having valid RST is important so that Pypi's web interface interprets
the RST correctly and display long_description in a pretty format.
@coveralls
Copy link

coveralls commented Mar 7, 2018

Coverage Status

Coverage remained the same at 85.0% when pulling 5675baf on Flimm:fix-rst into b8fa111 on theskumar:master.

1 similar comment
@coveralls
Copy link

coveralls commented Mar 7, 2018

Coverage Status

Coverage remained the same at 85.0% when pulling 5675baf on Flimm:fix-rst into b8fa111 on theskumar:master.

@theskumar
Copy link
Owner

Looks great! Thanks @Flimm :)

@theskumar theskumar merged commit 07fffa1 into theskumar:master Mar 7, 2018
@theskumar
Copy link
Owner

It doesn't fix the formatting on pypi though. :(

https://pypi.python.org/pypi/python-dotenv/0.8.1

theskumar pushed a commit that referenced this pull request Mar 7, 2018
@Flimm
Copy link
Contributor Author

Flimm commented Mar 7, 2018

That's so weird. That's the first time I've seen that python setup.py check -rsm failed to catch an RST issue that Pypi web was having.

@theskumar
Copy link
Owner

Never mine. Converted the doc to markdown and now I'm converting to rst just before upload. Solves the issue and makes the little easier to maintain as well (atleast for me)

johnbergvall pushed a commit to johnbergvall/python-dotenv that referenced this pull request Aug 13, 2021
The test is not run in Python 3.3 because of this bug:

https://sourceforge.net/p/docutils/bugs/270/

Having valid RST is important so that Pypi's web interface interprets
the RST correctly and display long_description in a pretty format.
johnbergvall pushed a commit to johnbergvall/python-dotenv that referenced this pull request Aug 13, 2021
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.

3 participants