Fix PyPI long description rendering #1739
Merged
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
Currently the rendering of gensim's reStructuredText description on PyPI
is broken[1][2], because some characters aren't escaped properly[3]:
>reStructuredText uses backslashes ("\") to override the special meaning
>given to markup characters and get the literal characters themselves.
>To get a literal backslash, use an escaped backslash ("\\").
[1]: https://pypi.python.org/pypi/gensim/3.1.0/
[2]: https://pypi.org/project/gensim/3.1.0/
[3]: http://docutils.sourceforge.net/docs/user/rst/quickref.html#escaping
|
Thanks! How can we test this, before releasing? |
https://packaging.python.org/guides/using-testpypi/ If you want to test the legacy PyPI you should probably replace |
|
This is interesting, thanks. Ping @isamaru @menshikh-iv FYI. |
|
Thanks for information @edigaryev, congratz with first contribution to gensim 🔥 🥇 |
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.
Currently the rendering of gensim's reStructuredText description on PyPI
is broken[1][2], because some characters aren't escaped properly[3]: