diff options
| author | Dylan Baker <dylan@pnwbakers.com> | 2025-07-19 21:50:09 -0700 |
|---|---|---|
| committer | Dylan Baker <dylan@pnwbakers.com> | 2025-07-22 09:05:22 -0700 |
| commit | 092ab8c9e117cc00aa699c8d513572f95009cae8 (patch) | |
| tree | f1423cd24212df161a9c45247d3cf78e87737659 /docs/yaml/objects/generator.yaml | |
| parent | 2b7661a43f8e85d666dd66ecddb85aedb154a58c (diff) | |
| download | meson-092ab8c9e117cc00aa699c8d513572f95009cae8.tar.gz | |
Docs: standardize between list and array as array
When arrays were added they were called arrays. Because the are
implemented with Python lists, that language started leaking into
talking about Meson types. This is confusing. I've attempted, as much as
possible, to move to using one name, array. I picked array because 1)
It's the original name used, and 2) what Meson has are more properly
arrays as they have a fixed length, while a critical property of lists
are the ability to link and unlink them.
There are a couple of places where the list language has leaked into the
names of keyword arguments. I have not made any attempt to change those,
I don't know if it's that useful or not.
Diffstat (limited to 'docs/yaml/objects/generator.yaml')
| -rw-r--r-- | docs/yaml/objects/generator.yaml | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/yaml/objects/generator.yaml b/docs/yaml/objects/generator.yaml index fbef95fa4..3dbcdd5d9 100644 --- a/docs/yaml/objects/generator.yaml +++ b/docs/yaml/objects/generator.yaml @@ -9,20 +9,20 @@ methods: - name: process returns: generated_list description: | - Takes a list of files, causes them to be processed and returns an object containing the result + Takes an array of files, causes them to be processed and returns an object containing the result which can then, for example, be passed into a build target definition. varargs: name: source min_varargs: 1 type: str | file | custom_tgt | custom_idx | generated_list - description: List of sources to process. + description: sources to process. kwargs: extra_args: - type: list[str] + type: array[str] description: | - If present, will be used to replace an entry `@EXTRA_ARGS@` in the argument list. + If present, will be used to replace an entry `@EXTRA_ARGS@` in the argument array. preserve_path_from: type: str @@ -36,7 +36,7 @@ methods: directory}/one.out`. env: - type: env | list[str] | dict[str] + type: env | array[str] | dict[str] since: 1.3.0 description: | environment variables to set, such as |