REL: Add a short description to setup.py #458
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
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.
Noticed that the short description field in
setup.pypreviously just saidEmpress; this replaces that with a slightly modified version of the description used for the GitHub repo.I guess the motivation here is that some websites (e.g. pypi.org) which show information about PyPI packages start with the short description, so it would be nice to have such a description. For comparison, here are the PyPI pages for Empress and Gneiss. The short descriptions are shown in the gray bar in the middle of the page, just below the blue section and above the white section; Gneiss has a short description listed here, while Empress' just says
Empress.