style: lead the help overview with what Picklock is - #6
Merged
Conversation
The first line of the first page a new reader sees said how to type a command before saying what they were looking at. The identity line goes first, the usage line second.
A patch: the help overview prints the same two lines in the other order. The quickstart's banner sample, the Sphinx fallback and the terminal capture carry the version literally, so all three move with it.
github-actions
Bot
added
docs
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.
What
helpopened with the usage line, so the first thing a new reader saw was howto type a command rather than what they were looking at. The identity line goes
first.
Before:
After:
Same two lines, swapped. Nothing else on the page moves, and no other help page
is affected.
Version
Bumped to 0.2.1 — a patch, since only the order of two lines changed.
picklock/__init__.pyis the source hatch reads;docs/quickstart.md, theSphinx fallback in
docs/conf.pyand the terminal capture spell the versionout, so they move with it.
Checks
pytest: 927 passed.make lintandmake type-checkclean.