Skip to content

Commit 6d80dc3

Browse files
iainelderkpfleming
authored andcommitted
Update option syntax in README for clarity
Make it clearer to a new user how to use arrays. I was trying `--array-name foo` and getting nowhere.
1 parent 8e51cc7 commit 6d80dc3

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ JSON data input format.
286286

287287
#### Options
288288

289-
* `array-name`: accepts a single string (e.g. `array-name=foo`), which
289+
* `array-name`: accepts a single string (e.g. `--format-option array-name=foo`), which
290290
must be a valid Python identifier and not a Python keyword. If this
291291
option is specified, and the JSON data provided is an `array`
292292
(sequence, list), the specified name will be used to make the data
@@ -321,7 +321,7 @@ YAML data input format.
321321

322322
#### Options
323323

324-
* `sequence-name`: accepts a single string (e.g. `sequence-name=foo`),
324+
* `sequence-name`: accepts a single string (e.g. `--format-option sequence-name=foo`),
325325
which must be a valid Python identifier and not a Python keyword. If
326326
this option is specified, and the YAML data provided is a `sequence`
327327
(array, list), the specified name will be used to make the data

0 commit comments

Comments
 (0)