From 789a7ea9503dc014ad83c7be9415bc7e0ec93b1d Mon Sep 17 00:00:00 2001 From: Pete Davison Date: Wed, 16 Apr 2025 15:59:35 +0000 Subject: [PATCH] docs: things aren't always simple --- Taskfile.yml | 2 +- website/docs/getting_started.mdx | 4 ++-- website/docs/usage.mdx | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Taskfile.yml b/Taskfile.yml index cd984e4c..ae4d82de 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -167,7 +167,7 @@ tasks: - Push the commit/tag to the repository - Create a GitHub release - To use the task, simply run "task release:" where "" is is one of: + To use the task, run "task release:" where "" is is one of: - "major" - Bumps the major number - "minor" - Bumps the minor number diff --git a/website/docs/getting_started.mdx b/website/docs/getting_started.mdx index bef3482e..e79108d2 100644 --- a/website/docs/getting_started.mdx +++ b/website/docs/getting_started.mdx @@ -62,8 +62,8 @@ the commands. ## Calling a task -To call the task, you simply invoke `task` followed by the name of the task you -want to run. In this case, the name of the task is `default`, so you should run: +To call the task, invoke `task` followed by the name of the task you want to +run. In this case, the name of the task is `default`, so you should run: ```shell task default diff --git a/website/docs/usage.mdx b/website/docs/usage.mdx index 001551ca..1942d947 100644 --- a/website/docs/usage.mdx +++ b/website/docs/usage.mdx @@ -1301,8 +1301,8 @@ tasks: ``` All references use the same templating syntax as regular templates, so in -addition to simply calling `.FOO`, you can also pass subkeys (`.FOO.BAR`) or -indexes (`index .FOO 0`) and use functions (`len .FOO`) as described in the +addition to calling `.FOO`, you can also pass subkeys (`.FOO.BAR`) or indexes +(`index .FOO 0`) and use functions (`len .FOO`) as described in the [templating-reference][templating-reference]: ```yaml @@ -1511,9 +1511,9 @@ tasks: ### Looping over variables -To loop over the contents of a variable, you simply need to specify the variable -you want to loop over. By default, string variables will be split on any -whitespace characters. +To loop over the contents of a variable, use the `var` key followed by the name +of the variable you want to loop over. By default, string variables will be +split on any whitespace characters. ```yaml version: '3'