Document module doc comments in readme (#2208)

casey · Jun 29, 2024 · e0c0312 · e0c0312
1 parent ef6a813
commit e0c0312
Showing 1 changed file with 14 additions and 0 deletions.
diff --git 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.