Skip to content

Commit af14594

Browse files
author
Sara Safavi
committed
make --tools documentation more explicit
1 parent 9d45fe8 commit af14594

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/source/cli/examples.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,10 @@ on your order prior to download. To read more about tools & toolchains, visit
242242
`the docs <https://developers.planet.com/docs/orders/tools-toolchains/>`_ .
243243

244244
To add tool operations to your order, use the `--tools` option to specify a
245-
json-formatted file containing a list of the desired tools an their settings.
245+
json-formatted file containing an array (list) of the desired tools an their
246+
settings.
247+
248+
.. note:: The json-formatted file must be formatted as an array (enclosed in square brackets), even if only specifying a single tool
246249

247250
For example, to apply the 3 tools `TOAR -> Reproject -> Tile` in sequence to an
248251
order, you would create a `.json` file similar to the following::

0 commit comments

Comments
 (0)