Skip to content

docs: Clarify internal and desc behaviors #3000

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

Open
MikeGarde wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −2
Open

docs: Clarify internal and desc behaviors #3000

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
7 changes: 5 additions & 2 deletions website/src/next/docs/reference/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,8 @@ includes:

- **Type**: `bool`
- **Default**: `false`
- **Description**: Hide included tasks from command line and `--list`
- **Description**: Makes a task inaccessible from the command line and hidden
from `--list`, restricting its execution to other tasks only.

```yaml
includes:
Expand Down Expand Up @@ -529,7 +530,9 @@ tasks:
#### `desc`

- **Type**: `string`
- **Description**: Short description shown in `--list`
- **Description**: Short description shown in `--list`. If omitted, the task
will not be listed in `--list`, but will remain publicly callable from the
command line.

```yaml
tasks:
Expand Down