From e0c031272d12d986316b5972ab5762e3333b8e5e Mon Sep 17 00:00:00 2001
From: Casey Rodarmor <casey@rodarmor.com>
Date: Sat, 29 Jun 2024 12:28:47 -0700
Subject: [PATCH] Document module doc comments in readme (#2208)

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index b13e6e7..fc4d866 100644
--- a/README.md
+++ b/README.md
@@ -3228,6 +3228,20 @@ mod? foo 'bar.just'
 mod? foo 'baz.just'
 ```
 
+Modules may be given doc comments which appear in `--list`
+output<sup>master</sup>:
+
+```mf
+# foo is a great module!
+mod foo
+```
+
+```sh
+$ just --list
+Available recipes:
+    foo ... # foo is a great module!
+```
+
 See the
 [module stabilization tracking issue](https://github.com/casey/just/issues/929)
 for more information.