diff --git a/README.md b/README.md index 0e1149df..8de9796d 100644 --- a/README.md +++ b/README.md @@ -1704,28 +1704,28 @@ $ just foo 0123456789abcdef ``` -### Recipe Attributes +### Attributes -Recipes may be annotated with attributes that change their behavior. +Recipes, `mod` statements, and aliases may be annotated with attributes that change their behavior. -| Name | Description | -|------|-------------| -| `[confirm]`1.17.0 | Require confirmation prior to executing recipe. | -| `[confirm('PROMPT')]`1.23.0 | Require confirmation prior to executing recipe with a custom prompt. | -| `[doc('DOC')]`1.27.0 | Set recipe's [documentation comment](#documentation-comments) to `DOC`. | -| `[extension('EXT')]`1.32.0 | Set shebang recipe script's file extension to `EXT`. `EXT` should include a period if one is desired. | -| `[group('NAME')]`1.27.0 | Put recipe in [recipe group](#recipe-groups) `NAME`. | -| `[linux]`1.8.0 | Enable recipe on Linux. | -| `[macos]`1.8.0 | Enable recipe on MacOS. | -| `[no-cd]`1.9.0 | Don't change directory before executing recipe. | -| `[no-exit-message]`1.7.0 | Don't print an error message if recipe fails. | -| `[no-quiet]`1.23.0 | Override globally quiet recipes and always echo out the recipe. | -| `[positional-arguments]`1.29.0 | Turn on [positional arguments](#positional-arguments) for this recipe. | -| `[private]`1.10.0 | See [Private Recipes](#private-recipes). | -| `[script]`master | Execute recipe as script. See [script recipes](#script-recipes) for more details. | -| `[script(COMMAND)]`1.32.0 | Execute recipe as a script interpreted by `COMMAND`. See [script recipes](#script-recipes) for more details. | -| `[unix]`1.8.0 | Enable recipe on Unixes. (Includes MacOS). | -| `[windows]`1.8.0 | Enable recipe on Windows. | +| Name | Type | Description | +|------|------|-------------| +| `[confirm]`1.17.0 | recipe | Require confirmation prior to executing recipe. | +| `[confirm('PROMPT')]`1.23.0 | recipe | Require confirmation prior to executing recipe with a custom prompt. | +| `[doc('DOC')]`1.27.0 | module, recipe | Set recipe or module's [documentation comment](#documentation-comments) to `DOC`. | +| `[extension('EXT')]`1.32.0 | recipe | Set shebang recipe script's file extension to `EXT`. `EXT` should include a period if one is desired. | +| `[group('NAME')]`1.27.0 | module, recipe | Put recipe or module in in [group](#groups) `NAME`. | +| `[linux]`1.8.0 | recipe | Enable recipe on Linux. | +| `[macos]`1.8.0 | recipe | Enable recipe on MacOS. | +| `[no-cd]`1.9.0 | recipe | Don't change directory before executing recipe. | +| `[no-exit-message]`1.7.0 | recipe | Don't print an error message if recipe fails. | +| `[no-quiet]`1.23.0 | recipe | Override globally quiet recipes and always echo out the recipe. | +| `[positional-arguments]`1.29.0 | recipe | Turn on [positional arguments](#positional-arguments) for this recipe. | +| `[private]`1.10.0 | alias, recipe | Make recipe or alias private. See [Private Recipes](#private-recipes). | +| `[script]`master | recipe | Execute recipe as script. See [script recipes](#script-recipes) for more details. | +| `[script(COMMAND)]`1.32.0 | recipe | Execute recipe as a script interpreted by `COMMAND`. See [script recipes](#script-recipes) for more details. | +| `[unix]`1.8.0 | recipe | Enable recipe on Unixes. (Includes MacOS). | +| `[windows]`1.8.0 | recipe | Enable recipe on Windows. | A recipe can have multiple attributes, either on multiple lines: @@ -1816,9 +1816,9 @@ delete-everything: rm -rf * ``` -### Recipe Groups +### Groups -Recipes can be annotated with a group name: +Recipes and modules may be annotated with a group name: ```just [group('lint')] @@ -1844,7 +1844,6 @@ Recipes are listed by group: ``` $ just --list Available recipes: - (no group) email-everyone # not in any group [lint]