Help: JSON argument should be quoted

The error that results from a semicolon anywhere in a JSON string
is not obvious.

Issue: #26628
This commit is contained in:
scivision
2025-01-24 09:52:13 -05:00
committed by Brad King
parent a2267f337a
commit 7be01178a0

View File

@@ -523,6 +523,10 @@ Functionality for querying a JSON string.
option is not present, a fatal error message is generated. If no error
occurs, the ``<error-variable>`` will be set to ``NOTFOUND``.
In the following subcommands, the ``<json-string>`` argument should
be written as a :ref:`Quoted Argument` to ensure the entire JSON
string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-variable>]
GET <json-string> <member|index> [<member|index> ...])