CI: add job that checks README.rst against usbsdmux -h output #64
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
The usbsdmux -h output in the README.rst has become out of date with the actual output in multiple PRs recently. Make sure that does not happen again. Signed-off-by: Leonard Göhrs <[email protected]>
A README that does not match the behaviour of the program can be quite confusing. Sync the usbsdmux -h output with the actual output. Signed-off-by: Leonard Göhrs <[email protected]>
|
Nice! Thanks for catching that! |
jluebbe
requested changes
Dec 21, 2023
|
|
||
| optional arguments: | ||
| -h, --help show this help message and exit | ||
| $ usbsdmux -h |
There was a problem hiding this comment.
This changes the indention from the conventional three spaces to four spaces.
There was a problem hiding this comment.
… conventional three spaces …
Tehe, the reStructuredText format never fails to surprise me.
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.
The
usbsdmux -houtput in theREADME.rsthas become out of date with the actual output of the tool.This can be quite confusing, as it makes it unclear which features the tool has.
Update the
README.rstcontent and make sure it stays up to date via a CI job.See this job run for an example of the job failing.