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

Explain specific requirements for Markdown descriptions #522

Merged
merged 2 commits into from Jun 15, 2018

Conversation

Projects
None yet
3 participants
@pgadige
Contributor

pgadige commented Jun 13, 2018

Added a note about requirements for Markdown descriptions on PyPI.

Fixes #481

@@ -40,6 +40,27 @@ Set the value of ``long_description`` to the contents (not the path) of the READ
Set the ``long_description_content_type`` to an accepted ``Content-Type``-style value for your README file's markup,
such as ``text/plain``, ``text/x-rst`` (for reStructuredText), or ``text/markdown``.
.. Note:: If you're using GitHub-flavored Markdown to write a project's description, ensure you upgrade

This comment has been minimized.

@pradyunsg

pradyunsg Jun 13, 2018

Member

minor nit: use lowercase directive (like rest of file) + move statement to a new line for clarity.

.. note:: 

   If you're using GitHub-flavored Markdown to write a project's description, ensure you 
   upgrade the following tools:
.. code-block:: bash
twine upload dist/*

This comment has been minimized.

@pradyunsg

pradyunsg Jun 13, 2018

Member

minor nit: too many newlines

python3 -m pip install --user --upgrade setuptools wheel twine
The preferred versions:

This comment has been minimized.

@pradyunsg

pradyunsg Jun 13, 2018

Member

Can this be worded as something along the lines of the following instead?

The minimum required versions of the respective tools are:
The preferred versions:
- ``setuptools>=38.6.0``

This comment has been minimized.

@pradyunsg

pradyunsg Jun 13, 2018

Member

I think we should add spaces around >=.

I find setuptools >= 38.6.0 more readable than setuptools>=38.6.0.

@pgadige

This comment has been minimized.

Contributor

pgadige commented Jun 13, 2018

Thank you for your valuable feedback, @pradyunsg ! I've made the necessary changes. Please let me know if any further improvements are needed.

@pradyunsg

LGTM. :)

@theacodes theacodes merged commit ca4cb58 into pypa:master Jun 15, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@theacodes

This comment has been minimized.

Member

theacodes commented Jun 15, 2018

Thanks again, @pgadige!

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