Previously it could appear at first glance like the value of the config was an array - arguably a bit misleading.
I rearranged the section to put the code example first, then a description of the response, then the response block.
I renamed the response block to a sample, rather than an example.
No other content changes were made.
I suspect we might need a wider effort to change the statement that "return value is array" - it's really a promise containing an array - but that's happened on every section of the template docs so I don't want to do that without a ticket.
Pre-checks:
[x] Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/
[x] ~modules/ROOT/nav.adoc has been updated (if applicable)~
[x] ~Files has been included where required (if applicable)~
[x] ~Files removed have been deleted, not just excluded from the build (if applicable)~
[x] ~Files added for New product features, and included a release note entry.~
Site: Staging branch
Changes:
I suspect we might need a wider effort to change the statement that "return value is array" - it's really a promise containing an array - but that's happened on every section of the template docs so I don't want to do that without a ticket.
Pre-checks:
feature/<version>/
,hotfix/<version>/
,staging/<version>/
, orrelease/<version>/
modules/ROOT/nav.adoc
has been updated(if applicable)
~(if applicable)
~(if applicable)
~New product features
, and included arelease note
entry.~Review: