Minor enhancements to README file & fix to setup.py #934
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
The original code ended up cutting off the first line of the readme.rst file. Replaced it with something that doesn't do that and is a bit simpler.
This fixes a couple of typos, adds a couple of badges, and tries to adjust some spacing issues. (The result looks better on PyPI than on GitHub because of GitHub's poor support for reStructuredText.)
ncrubin
approved these changes
Feb 4, 2025
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.
This fixes a problem with a couple of links, some typos, adds a couple of badges, adds alt text to logo images, and tries to adjust some spacing issues. (Note that the result looks better on PyPI than on GitHub because of GitHub's poor support for reStructuredText.) There is very little actual content change in the README file here, apart from some changes in a few words here and there in an effort to improve clarity.
It also fixes a small bug in setup.py.