docs: trim the README badge row and drop the doc link table - #7
Merged
Conversation
README-only change: the PyPI badge links now point at the lowercase project URL, a downloads badge joins the badge row, the documentation link table comes out in favour of the prose above it, and the two section headings drop their emoji. The quickstart banner, the Sphinx fallback and the terminal capture carry the version literally, so all three move with it.
github-actions
Bot
added
docs
JeanExtreme002
changed the title
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
1 participant
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.
Summary
README housekeeping, plus the patch bump that carries it.
pypi.org/project/picklock/URL.picklock.readthedocs.ioand says what lives there, so the table restated it a second time.ContributingandRelatedheadings drop their emoji.Version
0.2.1→0.2.2. Nothing in the package's behaviour changed, but the version string is printed in the welcome banner and reproduced literally in three places, so all three move with it:picklock/__init__.py, the Sphinx fallback indocs/conf.py, and the sample banner indocs/quickstart.md. The terminal capture inassets/screenshots/terminal.pngshows the banner too, so it was regenerated withscripts/generate_terminal_image.py.Test plan
scripts/generate_terminal_image.pyreruns clean and the new capture readsPicklock 0.2.2.python-package.yml) green.