mirror of
https://github.com/casey/just.git
synced 2024-09-11 05:55:31 +03:00
Document module doc comments in readme (#2208)
This commit is contained in:
parent
ef6a813dd1
commit
e0c031272d
14
README.md
14
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.
|
||||
|
Loading…
Reference in New Issue
Block a user