slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;imp: cli: also mention 'y' and 'n' in help

Browse Source
This commit is contained in:
Simon Michael 2024-05-29 16:10:04 -10:00
parent 7d0e605bc3
commit 9d53698eab
2 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/common.m4
View File

@ -121,14 +121,13 @@ General output/reporting flags (supported by some commands):
YYYY-MM-DD: value on given date YYYY-MM-DD: value on given date
-c --commodity-style=S Override a commodity's display style. -c --commodity-style=S Override a commodity's display style.
Eg: -c '$1000.' or -c '1.000,00 EUR' Eg: -c '$1000.' or -c '1.000,00 EUR'
--color=YN --colour Use ANSI color codes in text output? Can be: --color=YN --colour Use ANSI color codes in text output? Can be
'yes' or 'always', 'y'/'yes'/'always', 'n'/'no'/'never' or 'auto'.
'no' or 'never' (a NO_COLOR env var forces this), (A NO_COLOR environment variable overrides this.)
'auto' (the default: when using a color terminal).
--pretty[=YN] Use box-drawing characters in text output? Can be --pretty[=YN] Use box-drawing characters in text output? Can be
'yes' (the default argument for --pretty) or 'no'. 'y'/'yes' or 'n'/'no'.
If YN is specified, the equals is required. If YN is specified, the equals is required.
--debug=[N] show debug output (levels 1-9, default: 1) --debug=[1-9] show this level of debug output (default: 1)
General help flags: General help flags:
-h --help show command line help -h --help show command line help

9
hledger/Hledger/Cli/CliOptions.hs
View File

@ -228,13 +228,12 @@ reportflags = [
-- This has special support in hledger-lib:colorOption, keep synced -- This has special support in hledger-lib:colorOption, keep synced
,flagReq ["color","colour"] (\s opts -> Right $ setopt "color" s opts) "YN" ,flagReq ["color","colour"] (\s opts -> Right $ setopt "color" s opts) "YN"
(unlines (unlines
["Use ANSI color codes in text output? Can be:" ["Use ANSI color codes in text output? Can be"
,"'yes' or 'always'," ,"'y'/'yes'/'always', 'n'/'no'/'never' or 'auto'."
,"'no' or 'never' (a NO_COLOR env var forces this)," ,"(A NO_COLOR environment variable overrides this.)"
,"'auto' (the default: when using a color terminal)."
]) ])
,flagOpt "yes" ["pretty"] (\s opts -> Right $ setopt "pretty" s opts) "YN" ,flagOpt "yes" ["pretty"] (\s opts -> Right $ setopt "pretty" s opts) "YN"
"Use box-drawing characters in text output? Can be\n'yes' (the default argument for --pretty) or 'no'.\nIf YN is specified, the equals is required." "Use box-drawing characters in text output? Can be\n'y'/'yes' or 'n'/'no'.\nIf YN is specified, the equals is required."
-- flagOpt would be more correct for --debug, showing --debug[=LVL] rather than --debug=[LVL]. -- flagOpt would be more correct for --debug, showing --debug[=LVL] rather than --debug=[LVL].
-- But because we handle --debug specially, flagReq also works, and it does not need =, removing a source of confusion. -- But because we handle --debug specially, flagReq also works, and it does not need =, removing a source of confusion.