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/elementary | |
| 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/elementary')
| -rw-r--r-- | docs/yaml/elementary/array.yml (renamed from docs/yaml/elementary/list.yml) | 10 | ||||
| -rw-r--r-- | docs/yaml/elementary/dict.yml | 2 | ||||
| -rw-r--r-- | docs/yaml/elementary/str.yml | 6 |
3 files changed, 9 insertions, 9 deletions
diff --git a/docs/yaml/elementary/list.yml b/docs/yaml/elementary/array.yml index 430f871f9..7d0480a04 100644 --- a/docs/yaml/elementary/list.yml +++ b/docs/yaml/elementary/array.yml @@ -1,5 +1,5 @@ -name: list -long_name: List +name: array +long_name: Array description: An array of elements. See [arrays](Syntax.md#arrays). is_container: true @@ -30,7 +30,7 @@ methods: posargs: index: type: int - description: Index of the list position to query. Negative values start at the end of the list + description: Index of the array position to query. Negative values start at the end of the array optargs: fallback: @@ -39,9 +39,9 @@ methods: - name: length returns: int - description: Returns the current size of the array / list. + description: Returns the current size of the array. - name: flatten - returns: list[any] + returns: array[any] since: 1.9.0 description: Returns a flattened copy of the array, with all nested arrays removed. diff --git a/docs/yaml/elementary/dict.yml b/docs/yaml/elementary/dict.yml index 19263dfa1..70844bb3b 100644 --- a/docs/yaml/elementary/dict.yml +++ b/docs/yaml/elementary/dict.yml @@ -44,5 +44,5 @@ methods: description: Fallback value that is returned if the key is not in the [[@dict]]. - name: keys - returns: list[str] + returns: array[str] description: Returns an array of keys in the dictionary. diff --git a/docs/yaml/elementary/str.yml b/docs/yaml/elementary/str.yml index 44aa74240..c70a4f5dc 100644 --- a/docs/yaml/elementary/str.yml +++ b/docs/yaml/elementary/str.yml @@ -203,7 +203,7 @@ methods: # str.split - name: split - returns: list[str] + returns: array[str] description: | Splits the string at the specified character (or whitespace if not set) and returns the parts in an @@ -224,7 +224,7 @@ methods: description: Specifies the character / substring where to split the string. - name: splitlines - returns: list[str] + returns: array[str] since: 1.2.0 description: | Splits the string into an array of lines. @@ -270,7 +270,7 @@ methods: The strings to join with the current string. Before Meson *0.60.0* this function only accepts a single positional - argument of the type [[list[str]]]. + argument of the type [[array[str]]]. # str.underscorify - name: underscorify |