Fix package descriptions for pypi. #2958
Merged
Conversation
This file contains hidden or 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
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.
Description
Luigi's
long_descriptionseems to be broken on PyPI as of version 2.8.11.As @honnix pointed out, this could have been caused by a PR of me (and maybe the way that PyPI shows the short package description now in the grey top bar).
Changes and tests
As it turned out, the
readme_notedefined in setup.py must start with at least one line break, while the short description should not contain any of them. I added these two small changes and tested with a temporary PyPI package that looks fine (going to delete it again after the merge). I usedfor the release.