clap/clap_mangen/tests/snapshots/hidden_option.bash.roff at 1add9a7ae4fab6088d2047ef4b7f9b6e6c478f13 - Mirrors/clap - CherryKitten

Mirrors/clap

mirror of https://github.com/clap-rs/clap synced 2024-12-15 07:12:32 +00:00

Ed Page 36bc641648 fix(help): Remove extraneous text from built-ins

This is an intermediate solution for #4408.  As there were no agreeed
upon goals, I went with what I felt read well and that I saw commonly
used on non-clap commands.

- "information" isn't really a necessary word.
- I originally favored `Print this help` but realied that doesn't read
  correctly in completions.
- Besides being shorter, the reason for the flipped short/long hint is
  it gives people the context they need for scanning, emphasizing
  "summary" and "more".

Fixes #4409

2023-01-03 11:02:26 -06:00

15 lines

242 B

Text

Raw Blame History

 .ie /n(.g .ds Aq /(aq
 .el .ds Aq '
 .TH my-app 1  "my-app "
 .SH NAME
 my/-app
 .SH SYNOPSIS
 /fBmy/-app/fR [/fB/-/-config/fR] [/fB/-h/fR|/fB/-/-help/fR]
 .SH DESCRIPTION
 .SH OPTIONS
 .TP
 /fB/-/-config/fR
 .TP
 /fB/-h/fR, /fB/-/-help/fR
 Print help