greg/just
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document module doc comments in readme (#2208)

Browse Source
This commit is contained in:
Casey Rodarmor 2024-06-29 12:28:47 -07:00 committed by GitHub
parent ef6a813dd1
commit e0c031272d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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.