Skip to content

Commit 2c6b1e4

Browse files
committed
Updated docs
1 parent 6ab203a commit 2c6b1e4

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,16 @@ Required:
3737
templates. [required]
3838
3939
Output Type: [mutually exclusive]
40-
-j, --json Print metadata as JSON.
41-
-c, --csv Print metadata as CSV.
40+
-j, --json Print metadata as JSON. The JSON field name
41+
will be the same as the template name. You may
42+
specify a different field name by using the
43+
syntax: 'field_name:{template}' or
44+
'field_name={template}'.
45+
-c, --csv Print metadata as CSV. The CSV field name will
46+
be the same as the template name. You may
47+
specify a different field name by using the
48+
syntax: 'field_name:{template}' or
49+
'field_name={template}'.
4250
4351
Formatting Options:
4452
-f, --no-filename Do not print filename headers. Without -h/--no-

mdinfo/cli.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,14 +150,16 @@ def show_help(ctx: Context, param: "click.Parameter", value: str) -> None:
150150
"-j",
151151
"json_option",
152152
is_flag=True,
153-
help="Print metadata as JSON.",
153+
help="Print metadata as JSON. The JSON field name will be the same as the template name. "
154+
"You may specify a different field name by using the syntax: 'field_name:{template}' or 'field_name={template}'. ",
154155
),
155156
option(
156157
"--csv",
157158
"-c",
158159
"csv_option",
159160
is_flag=True,
160-
help="Print metadata as CSV.",
161+
help="Print metadata as CSV. The CSV field name will be the same as the template name. "
162+
"You may specify a different field name by using the syntax: 'field_name:{template}' or 'field_name={template}'. ",
161163
),
162164
constraint=mutually_exclusive,
163165
)

0 commit comments

Comments
 (0)