Standardize help commands and terminology for improved usability#14
Open
crashingstatic wants to merge 1 commit intoalexorso:masterfrom
Open
Standardize help commands and terminology for improved usability#14crashingstatic wants to merge 1 commit intoalexorso:masterfrom
crashingstatic wants to merge 1 commit intoalexorso:masterfrom
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
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.
PR: Standardize help commands and terminology for improved usability
Description
This PR implements the changes proposed in Issue #13 to improve command-line interface consistency. All instances of "manpage" have been replaced with "help page" throughout the codebase, and the non-standard
--manpageflag has been updated to use the UNIX standard-h/--helpflags.This change improves usability by adhering to well-established CLI conventions that users expect. As an additional benefit, it also aligns with inclusive language recommendations in GitHub's [Community Guidelines](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines#maintaining-a-strong-community) and the OpenSource Community's [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md).
Changes
--manpageto standard-h/--helpoptionsprint_man()→print_help())Testing
-h/--helpflags display help correctlyNotes for Reviewers
Related Issues
Resolves: #13 (Standardize help commands and terminology)