docs: YAML: Add `arg_flattening: false` where required

pull/10242/merge
Daniel Mensinger 3 years ago committed by Eli Schwartz
parent f192ecd1ef
commit 99f510a817
  1. 3
      docs/yaml/builtins/meson.yaml
  2. 2
      docs/yaml/elementary/dict.yml
  3. 4
      docs/yaml/elementary/list.yml
  4. 2
      docs/yaml/elementary/str.yml
  5. 2
      docs/yaml/functions/environment.yaml
  6. 2
      docs/yaml/functions/error.yaml
  7. 2
      docs/yaml/functions/get_variable.yaml
  8. 2
      docs/yaml/functions/message.yaml
  9. 2
      docs/yaml/functions/set_variable.yaml
  10. 2
      docs/yaml/functions/summary.yaml
  11. 2
      docs/yaml/functions/warning.yaml
  12. 2
      docs/yaml/objects/subproject.yaml

@ -259,6 +259,7 @@ methods:
This method is replaced by [[meson.get_external_property]].
arg_flattening: false
posargs_inherit: meson.get_external_property
optargs_inherit: meson.get_external_property
@ -269,6 +270,8 @@ methods:
Returns the given property from a native or cross file.
The optional fallback_value is returned if the given property is not found.
arg_flattening: false
posargs:
propname:
type: str

@ -30,6 +30,8 @@ methods:
fallback value given as the second argument. If a single argument
was given and the key was not found, causes a fatal error
arg_flattening: false
posargs:
key:
type: str

@ -10,6 +10,8 @@ methods:
Returns `true` if the array contains the object
given as argument, `false` otherwise
arg_flattening: false
posargs:
item:
type: any
@ -23,6 +25,8 @@ methods:
bounds returns the `fallback` value *(since 0.38.0)* or, if it is
not specified, causes a fatal error
arg_flattening: false
posargs:
index:
type: int

@ -21,6 +21,8 @@ methods:
# res now has value 'string: text, number: 1, bool: true'
```
arg_flattening: false
posargs:
fmt:
description: |

@ -3,6 +3,8 @@ returns: env
since: 0.35.0
description: Returns an empty [[@env]] object.
arg_flattening: false
optargs:
env:
type: str | list[str] | dict[str] | dict[list[str]]

@ -2,6 +2,8 @@ name: error
returns: void
description: Print the argument string and halts the build process.
arg_flattening: false
posargs:
message:
type: str

@ -8,6 +8,8 @@ description: |
`res`instead. If a fallback is not specified, then attempting to read
a non-existing variable will cause a fatal error.
arg_flattening: false
posargs:
variable_name:
type: str

@ -2,6 +2,8 @@ name: message
returns: void
description: This function prints its argument to stdout.
arg_flattening: false
posargs:
text:
type: str | int | bool | list[str | int | bool] | dict[str | int | bool]

@ -6,6 +6,8 @@ description: |
*(since 0.46.1)* The `value` parameter can be an array type.
arg_flattening: false
posargs:
variable_name:
type: str

@ -61,6 +61,8 @@ example: |
True
```
arg_flattening: false
posargs:
key_or_dict:
type: str | dict[str | bool | int | dep | external_program | list[str | bool | int | dep | external_program]]

@ -3,5 +3,7 @@ returns: void
since: 0.44.0
description: This function prints its argument to stdout prefixed with WARNING:.
arg_flattening: false
posargs_inherit: message
varargs_inherit: message

@ -19,6 +19,8 @@ methods:
If a fallback is not specified, then attempting to read a non-existing
variable will cause a fatal error.
arg_flattening: false
posargs:
var_name:
type: str

Loading…
Cancel
Save