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/markdown | |
| 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/markdown')
| -rw-r--r-- | docs/markdown/Release-notes-for-0.38.0.md | 2 | ||||
| -rw-r--r-- | docs/markdown/Syntax.md | 2 | ||||
| -rw-r--r-- | docs/markdown/Yaml-RefMan.md | 6 | ||||
| -rw-r--r-- | docs/markdown/i18n-module.md | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/docs/markdown/Release-notes-for-0.38.0.md b/docs/markdown/Release-notes-for-0.38.0.md index 5aaca0a81..7be99abf4 100644 --- a/docs/markdown/Release-notes-for-0.38.0.md +++ b/docs/markdown/Release-notes-for-0.38.0.md @@ -106,7 +106,7 @@ the check is now ~40% faster. ## Array indexing now supports fallback values The second argument to the array -[[list.get]] function is now returned +[[array.get]] function is now returned if the specified index could not be found ```meson diff --git a/docs/markdown/Syntax.md b/docs/markdown/Syntax.md index 05f503880..f4a2e1772 100644 --- a/docs/markdown/Syntax.md +++ b/docs/markdown/Syntax.md @@ -566,7 +566,7 @@ executable('exe1', 'foo.c', 'bar.c', 'foobar.c') Because of an internal implementation detail, the following syntax is currently also supported, even though the first argument of -[[executable]] is a single [[@str]] and not a [[@list]]: +[[executable]] is a single [[@str]] and not a [[@array]]: ```meson # WARNING: This example is only valid because of an internal diff --git a/docs/markdown/Yaml-RefMan.md b/docs/markdown/Yaml-RefMan.md index 287279173..cce844b6b 100644 --- a/docs/markdown/Yaml-RefMan.md +++ b/docs/markdown/Yaml-RefMan.md @@ -150,9 +150,9 @@ optargs: ... varargs: - name: Some name # [required] - type: str | list[str | int] # [required] - description: Some helpful text # [required] + name: Some name # [required] + type: str | array[str | int] # [required] + description: Some helpful text # [required] since: 0.42.0 deprecated: 100.99.0 min_varargs: 1 diff --git a/docs/markdown/i18n-module.md b/docs/markdown/i18n-module.md index da6fce74e..ac6146dd5 100644 --- a/docs/markdown/i18n-module.md +++ b/docs/markdown/i18n-module.md @@ -90,7 +90,7 @@ for each executable. Positional arguments are the following: * name `str`: the name of the resulting pot file. -* sources `list[str|File|build_tgt|custom_tgt]`: +* sources `array[str|File|build_tgt|custom_tgt]`: source files or targets. May be a list of `string`, `File`, [[@build_tgt]], or [[@custom_tgt]] returned from other calls to this function. |