Skip to content

Commit 4ea212e

Browse files
committed
Fix script meta docs
1 parent ace0759 commit 4ea212e

File tree

1 file changed

+15
-24
lines changed

1 file changed

+15
-24
lines changed

docs/targets/script/meta.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,71 +6,62 @@ This page provides a walkthrough of the `meta.yaml` file.
66

77
- **alias** (`string`)
88

9-
- Alias of the script, which can be used instead of tags when running a script.
9+
Alias of the script, which can be used instead of tags when running a script.
1010

1111
- **uid** (`string`)
1212

13-
- Unique identifier for individual scripts.
14-
15-
- Can be used instead of tags when running a script.
13+
Unique identifier for individual scripts. Can be used instead of tags when running a script.
1614

1715
- **automation_alias** (`string`)
1816

19-
- Alias specific to script automation.
17+
Alias specific to script automation.
2018

2119
- **automation_uid** (`string`)
2220

23-
- Unique identifier for script automation.
21+
Unique identifier for script automation.
2422

2523
- **category** (`string`)
2624

27-
- Defines the script category.
25+
Defines the script category.
2826

2927
- **tags** (`list of strings`)
3028

31-
- List of tags users can specify to run the script.
29+
List of tags users can specify to run the script.
3230

3331
- **default_env** (`dictionary` with `string` values)
3432

35-
- Contains key-value pairs representing environment variables and their default values for a script.
36-
37-
- These default values are overridden if the same environment variable is set in script files or inherited from a parent script.
33+
Contains key-value pairs representing environment variables and their default values for a script. These default values are overridden if the same environment variable is set in script files or inherited from a parent script.
3834

3935
- **env** (`dictionary` with `string` values)
4036

41-
- Defines environment variables and their corresponding values.
37+
Defines environment variables and their corresponding values.
4238

4339
- **input_mapping** (`dictionary` with `string` values)
4440

45-
- Maps input flags related to a script to corresponding environment variables.
46-
47-
- Only keys specified under `input_mapping` in `meta.yaml` are mapped to environment variables.
41+
Maps input flags related to a script to corresponding environment variables. Only keys specified under `input_mapping` in `meta.yaml` are mapped to environment variables.
4842

4943
- **env_key_mapping** (`dictionary` with `string` values)
5044

51-
- Maps one environment key to another.
45+
Maps one environment key to another just for the `run` script execution.
5246

5347
- **new_env_keys** (`list of strings`)
5448

55-
- Specifies environment keys that should be passed to a parent script if this script is used as a dependency.
49+
Specifies environment keys that should be passed to a parent script if this script is used as a dependency.
5650

5751
- **new_state_keys** (`list of strings`)
5852

59-
- Specifies state keys that should be passed to a parent script when used as a dependency.
53+
Specifies state keys that should be passed to a parent script when used as a dependency.
6054

6155
- **add_deps_recursive** (`dictionary`)
6256

63-
- Customizes recursive dependencies with nested `tags` and other attributes.
57+
Customizes recursive dependencies with nested `tags` and other attributes.
6458

6559
### Dependencies
6660

67-
Dependencies in a script are specified as a list of dictionaries.
68-
69-
- Each dictionary can contain:
61+
Dependencies in a script are specified as a list of dictionaries. Each dictionary can contain:
7062

7163
- **tags**
72-
73-
- Comma separated list of tags to identify a dependent script
64+
Comma separated list of tags to identify a dependent script
7465

7566
- **names** (`list of strings`)
7667

0 commit comments

Comments
 (0)