diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2022-01-06 23:53:11 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2022-01-07 00:50:42 -0700 |
| commit | bfe43bb0a7f2439dae5408b0ccfb5f9c06d60d86 (patch) | |
| tree | 268716829133f9b93d54ba99b7ec275d3eecd4de /docs/modules | |
| parent | 325d6e5ec30c91814db990453696b9d6630d7514 (diff) | |
resolves #4103 clarify that substitutions are not applied to the value of attributes defined via API or CLI
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/api/pages/options.adoc | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/modules/api/pages/options.adoc b/docs/modules/api/pages/options.adoc index 0a279c77..a91662a1 100644 --- a/docs/modules/api/pages/options.adoc +++ b/docs/modules/api/pages/options.adoc @@ -5,16 +5,19 @@ |Name |Description |Default value |Allowed values |`:attributes` -|Sets document attributes, which override equivalently-named attributes defined in the document unless soft set (`@`). -When using the hash format, a `nil` value unsets the attribute and a `false` value soft unsets the attribute. +|Sets document attributes, which override equivalently-named attributes defined in the document unless soft set. +No substitutions are applied to the value of these attributes. +In the hash format, a `nil` value hard unsets the attribute and a `false` value soft unsets the attribute. |_not set_ -|xref:asciidoc:attributes:document-attributes.adoc[Document attributes] in the following formats: +a|xref:asciidoc:attributes:document-attributes.adoc[Document attributes] in the following formats: -Hash: + -`{'name'\=>'value'}` + -Array: + -`['name=value']` + -String: + +*Hash* + +`{ 'name' \=> 'value' }` + +*Array* + +`[ 'name=value' ]` + +*String* (space separated) + `'name=value'` |`:backend` |