Skip to content

Commit bcd06f1

Browse files
committed
lint: let clap_help_markdown allow code spans in help text
Add `ignore_constructs = ["code_span"]` and restore the backticks in the two `--omit-json-shared-*` doc comments, then regenerate the completions, help text, `USAGE.md`, and man page. https://claude.ai/code/session_016ZyYFnzSv876usUHLEX4qe
1 parent 0fe4db3 commit bcd06f1

10 files changed

Lines changed: 21 additions & 18 deletions

File tree

USAGE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,12 @@ Set the maximum number of threads to spawn. Could be either "auto", "max", or a
125125
<a id="omit-json-shared-details" name="omit-json-shared-details"></a>
126126
### `--omit-json-shared-details`
127127

128-
Do not output .shared.details in the JSON output.
128+
Do not output `.shared.details` in the JSON output.
129129

130130
<a id="omit-json-shared-summary" name="omit-json-shared-summary"></a>
131131
### `--omit-json-shared-summary`
132132

133-
Do not output .shared.summary in the JSON output.
133+
Do not output `.shared.summary` in the JSON output.
134134

135135
<a id="option-h" name="option-h"></a><a id="help" name="help"></a>
136136
### `--help`

dylint.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,6 @@ allow_extra = ["assert_op_expr"]
3434

3535
["perfectionist::single_letter_closure_param"]
3636
extra_trivial_callback_methods = ["sort_reflection_by"]
37+
38+
["perfectionist::clap_help_markdown"]
39+
ignore_constructs = ["code_span"]

exports/completion.elv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ set edit:completion:arg-completer[pdu] = {|@words|
4848
cand --no-errors 'Prevent filesystem error messages from appearing in stderr'
4949
cand -p 'Report progress being made at the expense of performance'
5050
cand --progress 'Report progress being made at the expense of performance'
51-
cand --omit-json-shared-details 'Do not output .shared.details in the JSON output'
52-
cand --omit-json-shared-summary 'Do not output .shared.summary in the JSON output'
51+
cand --omit-json-shared-details 'Do not output `.shared.details` in the JSON output'
52+
cand --omit-json-shared-summary 'Do not output `.shared.summary` in the JSON output'
5353
cand -h 'Print help (see more with ''--help'')'
5454
cand --help 'Print help (see more with ''--help'')'
5555
cand -V 'Print version'

exports/completion.fish

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ complete -c pdu -l align-right -d 'Set the root of the bars to the right'
1818
complete -c pdu -l no-sort -d 'Do not sort the branches in the tree'
1919
complete -c pdu -s s -l silent-errors -l no-errors -d 'Prevent filesystem error messages from appearing in stderr'
2020
complete -c pdu -s p -l progress -d 'Report progress being made at the expense of performance'
21-
complete -c pdu -l omit-json-shared-details -d 'Do not output .shared.details in the JSON output'
22-
complete -c pdu -l omit-json-shared-summary -d 'Do not output .shared.summary in the JSON output'
21+
complete -c pdu -l omit-json-shared-details -d 'Do not output `.shared.details` in the JSON output'
22+
complete -c pdu -l omit-json-shared-summary -d 'Do not output `.shared.summary` in the JSON output'
2323
complete -c pdu -s h -l help -d 'Print help (see more with \'--help\')'
2424
complete -c pdu -s V -l version -d 'Print version'

exports/completion.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Register-ArgumentCompleter -Native -CommandName 'pdu' -ScriptBlock {
5151
[CompletionResult]::new('--no-errors', '--no-errors', [CompletionResultType]::ParameterName, 'Prevent filesystem error messages from appearing in stderr')
5252
[CompletionResult]::new('-p', '-p', [CompletionResultType]::ParameterName, 'Report progress being made at the expense of performance')
5353
[CompletionResult]::new('--progress', '--progress', [CompletionResultType]::ParameterName, 'Report progress being made at the expense of performance')
54-
[CompletionResult]::new('--omit-json-shared-details', '--omit-json-shared-details', [CompletionResultType]::ParameterName, 'Do not output .shared.details in the JSON output')
55-
[CompletionResult]::new('--omit-json-shared-summary', '--omit-json-shared-summary', [CompletionResultType]::ParameterName, 'Do not output .shared.summary in the JSON output')
54+
[CompletionResult]::new('--omit-json-shared-details', '--omit-json-shared-details', [CompletionResultType]::ParameterName, 'Do not output `.shared.details` in the JSON output')
55+
[CompletionResult]::new('--omit-json-shared-summary', '--omit-json-shared-summary', [CompletionResultType]::ParameterName, 'Do not output `.shared.summary` in the JSON output')
5656
[CompletionResult]::new('-h', '-h', [CompletionResultType]::ParameterName, 'Print help (see more with ''--help'')')
5757
[CompletionResult]::new('--help', '--help', [CompletionResultType]::ParameterName, 'Print help (see more with ''--help'')')
5858
[CompletionResult]::new('-V', '-V ', [CompletionResultType]::ParameterName, 'Print version')

exports/completion.zsh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ block-count\:"Count numbers of blocks"))' \
5353
'--no-errors[Prevent filesystem error messages from appearing in stderr]' \
5454
'-p[Report progress being made at the expense of performance]' \
5555
'--progress[Report progress being made at the expense of performance]' \
56-
'--omit-json-shared-details[Do not output .shared.details in the JSON output]' \
57-
'--omit-json-shared-summary[Do not output .shared.summary in the JSON output]' \
56+
'--omit-json-shared-details[Do not output \`.shared.details\` in the JSON output]' \
57+
'--omit-json-shared-summary[Do not output \`.shared.summary\` in the JSON output]' \
5858
'-h[Print help (see more with '\''--help'\'')]' \
5959
'--help[Print help (see more with '\''--help'\'')]' \
6060
'-V[Print version]' \

exports/long.help

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,10 @@ Options:
8686
[default: auto]
8787

8888
--omit-json-shared-details
89-
Do not output .shared.details in the JSON output
89+
Do not output `.shared.details` in the JSON output
9090

9191
--omit-json-shared-summary
92-
Do not output .shared.summary in the JSON output
92+
Do not output `.shared.summary` in the JSON output
9393

9494
-h, --help
9595
Print help (see a summary with '-h')

exports/pdu.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ Report progress being made at the expense of performance
109109
Set the maximum number of threads to spawn. Could be either "auto", "max", or a positive integer
110110
.TP
111111
\fB\-\-omit\-json\-shared\-details\fR
112-
Do not output .shared.details in the JSON output
112+
Do not output `.shared.details` in the JSON output
113113
.TP
114114
\fB\-\-omit\-json\-shared\-summary\fR
115-
Do not output .shared.summary in the JSON output
115+
Do not output `.shared.summary` in the JSON output
116116
.TP
117117
\fB\-h\fR, \fB\-\-help\fR
118118
Print help (see a summary with '\-h')

exports/short.help

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Options:
3939
--threads <THREADS>
4040
Set the maximum number of threads to spawn. Could be either "auto", "max", or a positive integer [default: auto]
4141
--omit-json-shared-details
42-
Do not output .shared.details in the JSON output
42+
Do not output `.shared.details` in the JSON output
4343
--omit-json-shared-summary
44-
Do not output .shared.summary in the JSON output
44+
Do not output `.shared.summary` in the JSON output
4545
-h, --help
4646
Print help (see more with '--help')
4747
-V, --version

src/args.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,11 +168,11 @@ pub struct Args {
168168
#[clap(long, default_value_t = Threads::Auto)]
169169
pub threads: Threads,
170170

171-
/// Do not output .shared.details in the JSON output.
171+
/// Do not output `.shared.details` in the JSON output.
172172
#[clap(long, requires = "json_output", requires = "deduplicate_hardlinks")]
173173
pub omit_json_shared_details: bool,
174174

175-
/// Do not output .shared.summary in the JSON output.
175+
/// Do not output `.shared.summary` in the JSON output.
176176
#[clap(long, requires = "json_output", requires = "deduplicate_hardlinks")]
177177
pub omit_json_shared_summary: bool,
178178
}

0 commit comments

Comments
 (0)