Skip to content

Commit af2402b

Browse files
committed
Tweak wording for include_context_lines help
1 parent 9740c56 commit af2402b

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,9 @@ at once, so `clang-tidy-review` will only attempt to post the first
120120
limitation of the GitHub API.
121121
- `num_comments_as_exitcode`: Set the exit code to be the amount of comments (enabled by default).
122122
- `extra_arguments`: Extra arguments to pass to the clang-tidy invocation.
123-
- `include_context_lines`: Include the 3 context lines above and below changes. These can still be commented on in Github Reviews (disabled by default).
123+
- `include_context_lines`: Include the 3 context lines above and below changes (default: false).
124+
This is useful when removing lines, as it allows `clang-tidy` to raise warnings on the context
125+
around deleted lines.
124126

125127
## Outputs
126128

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ inputs:
7474
required: false
7575
default: "0"
7676
include_context_lines:
77-
description: "Include the 3 context lines above and below changes. These can still be commented on in Github Reviews."
77+
description: "Include the 3 context lines above and below changes (default: false). This is useful when removing lines, as it allows `clang-tidy` to raise warnings on the context around deleted lines. Include the 3 context lines above and below changes. These can still be commented on in Github Reviews."
7878
required: false
7979
default: false
8080
pr:

0 commit comments

Comments
 (0)