Skip to content

Commit d2e950d

Browse files
committed
Standardize formatting of task parameter documentation
Some tasks accept input via environment variables. These parameter variables are documented in the task description. A standard format has been established for that documentation. Previously, these descriptions did not follow the standardized format
1 parent 0961097 commit d2e950d

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

Taskfile.yml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ tasks:
256256
desc: |
257257
Install dependencies managed by npm.
258258
Environment variable parameters:
259-
PROJECT_PATH: Path of the npm-managed project (default: {{.DEFAULT_NPM_PROJECT_PATH}}).
259+
- PROJECT_PATH: Path of the npm-managed project (default: {{.DEFAULT_NPM_PROJECT_PATH}}).
260260
dir: |
261261
"{{default .DEFAULT_NPM_PROJECT_PATH .PROJECT_PATH}}"
262262
run: when_changed
@@ -268,7 +268,7 @@ tasks:
268268
desc: |
269269
Validate npm configuration files against their JSON schema.
270270
Environment variable parameters:
271-
PROJECT_PATH: Path of the npm-managed project (default: {{.DEFAULT_NPM_PROJECT_PATH}}).
271+
- PROJECT_PATH: Path of the npm-managed project (default: {{.DEFAULT_NPM_PROJECT_PATH}}).
272272
deps:
273273
- task: npm:install-deps
274274
vars:
@@ -380,7 +380,7 @@ tasks:
380380
desc: |
381381
Install dependencies managed by Poetry.
382382
Environment variable parameters:
383-
POETRY_GROUPS: Poetry dependency groups to install (default: install all dependencies).
383+
- POETRY_GROUPS: Poetry dependency groups to install (default: install all dependencies).
384384
run: when_changed
385385
deps:
386386
- task: poetry:install
@@ -407,7 +407,9 @@ tasks:
407407
poetry check \
408408
--lock
409409
410-
# Make a temporary file named according to the passed TEMPLATE variable and print the path passed to stdout
410+
# Make a temporary file and print the path passed to stdout.
411+
# Environment variable parameters:
412+
# - TEMPLATE: template for the format of the filename.
411413
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/windows-task/Taskfile.yml
412414
utility:mktemp-file:
413415
vars:
@@ -418,7 +420,9 @@ tasks:
418420
vars:
419421
RAW_PATH: "{{.RAW_PATH}}"
420422

421-
# Print a normalized version of the path passed via the RAW_PATH variable to stdout
423+
# Print a normalized version of the path to stdout.
424+
# Environment variable parameters:
425+
# - RAW_PATH: the path to be normalized.
422426
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/windows-task/Taskfile.yml
423427
utility:normalize-path:
424428
cmds:

0 commit comments

Comments
 (0)