From 39e76488b533de1d1e433a95e4fc204bc3a66b13 Mon Sep 17 00:00:00 2001
From: Casey Rodarmor <casey@rodarmor.com>
Date: Mon, 7 Jun 2021 00:22:46 -0700
Subject: [PATCH] Mention `--list-heading` newline behavior (#860)

---
 README.adoc | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.adoc b/README.adoc
index 5f05d0b..7b18a12 100644
--- a/README.adoc
+++ b/README.adoc
@@ -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: