docs: Unify option descriptions between --help and the_basics.md#4076
Merged
JelleZijlstra merged 6 commits intopsf:mainfrom Dec 7, 2023
Merged
docs: Unify option descriptions between --help and the_basics.md#4076JelleZijlstra merged 6 commits intopsf:mainfrom
--help and the_basics.md#4076JelleZijlstra merged 6 commits intopsf:mainfrom
Conversation
Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com>
Signed-off-by: RedGuy12 <paul@reid-family.org>
The [skip news] label was added, and in retrospect this isn't changelog-worthy anyways. And I think I had a brainfart while writing the entry too 😅 Signed-off-by: RedGuy12 <paul@reid-family.org> Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com>
JelleZijlstra
approved these changes
Dec 7, 2023
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
2 participants
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.
Description
The descriptions for some options were inconsistent between the
--helpcommand and thethe_basicsdocumentation page. This PR unifies the two, as well as making the order consistant. Finally, the-xoption was previously not mentioned at all in the documentation, so I added it.Checklist - did you ...
CHANGES.mdif necessary?