Skip to content

Conversation

@crashingstatic
Copy link

@crashingstatic crashingstatic commented Mar 22, 2025

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 --manpage flag has been updated to use the UNIX standard -h/--help flags.

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

  • Replaced 36 instances of "manpage", "print_man", and "man page" in source files
  • Changed command-line flag from --manpage to standard -h/--help options
  • Updated function and variable names for consistency (e.g., print_man()print_help())
  • Updated documentation to reflect new command-line interface

Testing

  • Linux binaries build correctly
  • Verified that new -h/--help flags display help correctly
  • Confirmed help output refers consistently to "help page" terminology

Notes for Reviewers

  • Please check for any instances I may have missed
  • The command-line interface change should be included in the changelog as it affects user interaction
  • Please rebuild the binaries necessary to reflect these changes

Related Issues

Resolves: #13 (Standardize help commands and terminology)

@crashingstatic crashingstatic changed the title Replace "manpage" with "help page" throughout codebase Standardize to "help page" terminology for consistency with CLI conventions Mar 22, 2025
@crashingstatic crashingstatic changed the title Standardize to "help page" terminology for consistency with CLI conventions Standardize help commands and terminology for improved usability Mar 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize to "help page" terminology for consistency with CLI conventions

1 participant