xh icon indicating copy to clipboard operation
xh copied to clipboard

Man page improvements

Open ducaale opened this issue 3 years ago • 0 comments

Most of these proposed improvements are inspired by ripgrep:

  • Mention that body can be piped to xh in the usage section.
  • Briefly mention support for config files in the description section and have a dedicated section for it later.
  • Mention the native-tls feature flag in the description section.
  • Mention Strict compatibility mode in the description section.
  • Mention https mode in the description section.
  • Move the positional arguments section to outside of the options section.
  • Remove any spaces between each flag and its help message.
  • Mention --no-flag options in the description of the options section.
  • Replace short_help+long_help with long_help if needed. (This is done by using long_help attribute instead of doc comments)
  • Mention flags that affect other flags e.g --verbose enables --all or --json unsets --form.
  • Document what each possible value does if necessary e.g the values that --pretty takes.
  • Replace lists with a tabular format and use at least 4 spaces between columns.
  • Evaluate alternatives to help2man including asciidoctor (used by ripgrep) and clap_mangen.

ducaale avatar Mar 25 '22 20:03 ducaale