xh
xh copied to clipboard
Man page improvements
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-tlsfeature 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-flagoptions in the description of the options section. - Replace
short_help+long_helpwithlong_helpif needed. (This is done by usinglong_helpattribute instead of doc comments) - Mention flags that affect other flags e.g
--verboseenables--allor--jsonunsets--form. - Document what each possible value does if necessary e.g the values that
--prettytakes. - 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.