Skip to content
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

DESCRIPTION.RST: Extend underline #991

Merged
merged 1 commit into from
May 9, 2017
Merged

Conversation

msabramo
Copy link
Contributor

@msabramo msabramo commented May 6, 2017

I wonder if this is the reason that the description is not rendering properly on PyPI...?

https://pypi.python.org/pypi/dcos

I wonder if this is the reason that the description is not rendering properly on PyPI...?
@tamarrow-zz
Copy link
Contributor

Apparently pypi doesn't support markdown: http://stackoverflow.com/questions/26737222/pypi-description-markdown-doesnt-work

@msabramo
Copy link
Contributor Author

msabramo commented May 9, 2017

Yes, that is true that PyPI doesn't support Markdown. Which I know all too well:

However, this file (DESCRIPTION.rst) is reStructuredText.

$ pip install rstcheck
Collecting rstcheck
  Downloading rstcheck-3.1.tar.gz
Collecting docutils>=0.7 (from rstcheck)
  Using cached docutils-0.13.1-py3-none-any.whl
Building wheels for collected packages: rstcheck
  Running setup.py bdist_wheel for rstcheck ... done
  Stored in directory: /Users/abramowi/Library/Caches/pip/wheels/c1/b8/41/fe85fab5053ae89c25cd10e28f97fe68f08b36979d1c774268
Successfully built rstcheck
Installing collected packages: docutils, rstcheck
Successfully installed docutils-0.13.1 rstcheck-3.1

$ rstcheck DESCRIPTION.rst
DESCRIPTION.rst:2: (WARNING/2) Title underline too short.

so I think this PR will fix the issue.

Copy link
Contributor

@tamarrow-zz tamarrow-zz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you learn things every day. thanks

@tamarrow-zz tamarrow-zz merged commit 056302e into dcos:master May 9, 2017
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