From a9442330709b8dab4674d6c6c0fd42f4a8d0ff4b Mon Sep 17 00:00:00 2001 From: teatimeguest Date: Tue, 30 Jan 2024 22:15:56 +0900 Subject: [PATCH] docs: remove unnecessary docs for requires --- docs/docs/api_reference.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/api_reference.md b/docs/docs/api_reference.md index 7a5e02c900..69c3a46575 100644 --- a/docs/docs/api_reference.md +++ b/docs/docs/api_reference.md @@ -228,7 +228,6 @@ vars: | `sources` | `[]string` | | A list of sources to check before running this task. Relevant for `checksum` and `timestamp` methods. Can be file paths or star globs. | | `generates` | `[]string` | | A list of files meant to be generated by this task. Relevant for `timestamp` method. Can be file paths or star globs. | | `status` | `[]string` | | A list of commands to check if this task should run. The task is skipped otherwise. This overrides `method`, `sources` and `generates`. | -| `requires` | `[]string` | | A list of variables which should be set if this task is to run, if any of these variables are unset the task will error and not run. | | `preconditions` | [`[]Precondition`](#precondition) | | A list of commands to check if this task should run. If a condition is not met, the task will error. | | `requires` | [`Requires`](#requires) | | A list of required variables which should be set if this task is to run, if any variables listed are unset the task will error and not run. | | `dir` | `string` | | The directory in which this task should run. Defaults to the current working directory. |