Skip to content

Commit 8ecf5ba

Browse files
committed
docs: say what inert output blocks without overstating it
Newline and tab still move the cursor, so the note now says a commit message cannot send control sequences to the terminal, or workflow commands to a GitHub Actions runner.
1 parent b8c8f10 commit 8ecf5ba

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

‎docs/example.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,9 @@ To override the detection:
239239

240240
Whatever the destination, the commit text in a failure is printed inert.
241241
Control characters other than newline and tab appear as `\xNN`, and a line
242-
that starts with `::` is printed as `\::`, so a commit message cannot move the
243-
terminal's cursor or send a GitHub Actions runner a workflow command.
242+
that starts with `::` is printed as `\::`, so a commit message cannot send
243+
control sequences to the terminal, or workflow commands to a GitHub Actions
244+
runner.
244245
`--format json` is not affected; JSON escapes those characters already.
245246

246247
### Checking a range of commits

0 commit comments

Comments
 (0)