Explain specific requirements for Markdown descriptions #522
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pradyunsg
reviewed
Jun 13, 2018
| @@ -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 | |||
There was a problem hiding this comment.
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/* | ||
|
|
|
|
||
| python3 -m pip install --user --upgrade setuptools wheel twine | ||
|
|
||
| The preferred versions: |
There was a problem hiding this comment.
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`` |
There was a problem hiding this comment.
I think we should add spaces around >=.
I find setuptools >= 38.6.0 more readable than setuptools>=38.6.0.
|
Thank you for your valuable feedback, @pradyunsg ! I've made the necessary changes. Please let me know if any further improvements are needed. |
theacodes
approved these changes
Jun 15, 2018
|
Thanks again, @pgadige! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a note about requirements for Markdown descriptions on PyPI.
Fixes #481