Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document module doc comments #2208

Merged
merged 1 commit into from
Jun 29, 2024
Merged

Document module doc comments #2208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down