Skip to content

Commit 22aed16

Browse files
committed
[#151] Update docs example with new flatten helptext
1 parent 72c8ec7 commit 22aed16

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

examples/help/flatten/expected.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
usage: flatten-tool flatten [-h] [-s SCHEMA] [-f OUTPUT_FORMAT]
2-
[-m MAIN_SHEET_NAME] [-o OUTPUT_NAME]
3-
[--root-list-path ROOT_LIST_PATH] [--rollup]
4-
[-r ROOT_ID] [--use-titles]
1+
usage: flatten-tool flatten [-h] [-s SCHEMA] [-f OUTPUT_FORMAT] [--xml]
2+
[--id-name ID_NAME] [-m MAIN_SHEET_NAME]
3+
[-o OUTPUT_NAME] [--root-list-path ROOT_LIST_PATH]
4+
[--rollup] [-r ROOT_ID] [--use-titles]
55
input_name
66

77
positional arguments:
@@ -14,6 +14,8 @@ optional arguments:
1414
-f OUTPUT_FORMAT, --output-format OUTPUT_FORMAT
1515
Type of template you want to create. Defaults to all
1616
available options
17+
--xml Use XML as the input format
18+
--id-name ID_NAME String to use for the identifier key, defaults to 'id'
1719
-m MAIN_SHEET_NAME, --main-sheet-name MAIN_SHEET_NAME
1820
The name of the main sheet, as seen in the first tab
1921
of the spreadsheet for example. Defaults to main

flattentool/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def create_parser():
7171
parser_flatten.add_argument(
7272
"--xml",
7373
action='store_true',
74-
help="Use XML as the output format")
74+
help="Use XML as the input format")
7575
parser_flatten.add_argument(
7676
"--id-name",
7777
help="String to use for the identifier key, defaults to 'id'")

0 commit comments

Comments
 (0)