Mention --list-heading newline behavior (#860)

This commit is contained in:
Casey Rodarmor 2021-06-07 00:22:46 -07:00 committed by GitHub
parent 73337524b2
commit 39e76488b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -355,7 +355,7 @@ default:
The heading text can be customized with `--list-heading`:
```
$ just --list --list-heading 'Cool stuff…\n'
$ just --list --list-heading $'Cool stuff…\n'
Cool stuff…
test
build
@ -370,6 +370,16 @@ Available recipes:
····build
```
The argument to `--list-heading` replaces both the heading and the newline
following it, so it should contain a newline if non-empty. It works this way so
you can suppress the heading line entirely by passing the empty string:
```
$ just --list --list-heading ''
test
build
```
=== Aliases
Aliases allow recipes to be invoked with alternative names: