Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-14 14:52:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/clap_mangen/tests/snapshots/value_hint.bash.roff

57 lines
947 B
Text
Raw Normal View History

test(man): Add snapshot tests
2022-03-07 20:12:59 +00:00
.ie /n(.g .ds Aq /(aq
.el .ds Aq '
.TH my-app 1 "my-app "
.SH NAME
my/-app
.SH SYNOPSIS
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
/fBmy/-app/fR [/fB/-/-choice/fR] [/fB/-/-unknown/fR] [/fB/-/-other/fR] [/fB/-p/fR|/fB/-/-path/fR] [/fB/-f/fR|/fB/-/-file/fR] [/fB/-d/fR|/fB/-/-dir/fR] [/fB/-e/fR|/fB/-/-exe/fR] [/fB/-/-cmd/-name/fR] [/fB/-c/fR|/fB/-/-cmd/fR] [/fB/-u/fR|/fB/-/-user/fR] [/fB/-H/fR|/fB/-/-host/fR] [/fB/-/-url/fR] [/fB/-/-email/fR] [/fB/-h/fR|/fB/-/-help/fR] [/fIcommand_with_args/fR]
test(man): Add snapshot tests
2022-03-07 20:12:59 +00:00
.SH DESCRIPTION
.SH OPTIONS
.TP
/fB/-/-choice/fR
fix: Use roff bullet lists for possible_values
2022-08-23 18:38:57 +00:00
fix: Show possible values in generated man file This adds feature parity for mangen with the standard help output. Users will now see the list of possible values for value arguments. One change that was made to make this possible was adding the method `get_possible_values` to the public API for an arg. I tried to think of a way to get around this, but because this is the interface that the help generation uses, and it is part of the crate public interface I thing adding it as a part of the public API might be for the best. fixes: #3861
2022-08-10 20:54:53 +00:00
.br
fix: Add possible vals to man for positional args Noticed that possible values would not show up for Positional arguments as well. Decided to add the changes for those as well.
2022-08-24 02:09:16 +00:00
[/fIpossible values: /fRbash, fish, zsh]
test(man): Add snapshot tests
2022-03-07 20:12:59 +00:00
.TP
/fB/-/-unknown/fR
.TP
/fB/-/-other/fR
.TP
/fB/-p/fR, /fB/-/-path/fR
.TP
/fB/-f/fR, /fB/-/-file/fR
.TP
/fB/-d/fR, /fB/-/-dir/fR
.TP
/fB/-e/fR, /fB/-/-exe/fR
.TP
/fB/-/-cmd/-name/fR
.TP
/fB/-c/fR, /fB/-/-cmd/fR
.TP
/fB/-u/fR, /fB/-/-user/fR
.TP
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
/fB/-H/fR, /fB/-/-host/fR
test(man): Add snapshot tests
2022-03-07 20:12:59 +00:00
.TP
/fB/-/-url/fR
.TP
/fB/-/-email/fR
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
.TP
/fB/-h/fR, /fB/-/-help/fR
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 16:49:43 +00:00
Print help
test(man): Add snapshot tests
2022-03-07 20:12:59 +00:00
.TP
fix(clap_mangen): Use italic for replaceble args
2022-04-03 12:05:22 +00:00
[/fIcommand_with_args/fR]
test(man): Add snapshot tests
2022-03-07 20:12:59 +00:00
Reference in a new issue Copy permalink