Skip to content

Commit 308d243

Browse files
committed
🐛 Fix --help
The --help text mentioned the INPUT arguments which were renamed to METS_FILES. Update the text so it fits the renamed arguments. Fixes gh-44.
1 parent b5b88cf commit 308d243

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

src/mods4pandas/mods4pandas.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -544,14 +544,17 @@ def validate_mets_files(ctx, param, mets_files):
544544
)
545545
def process_command(mets_files: list[str], output_file: str, output_page_info: str, mets_files_list: str):
546546
"""
547-
A tool to convert the MODS metadata in INPUT to a pandas DataFrame.
547+
A tool to convert the MODS metadata in METS_FILES to a pandas DataFrame.
548548
549-
INPUT is assumed to be a METS document with MODS metadata. INPUT may optionally be a directory. The tool then reads
550-
all files in the directory.
549+
METS_FILES is assumed to be one or more METS documents with MODS metadata.
550+
METS_FILES may optionally be a directory. The tool then reads all files in the
551+
directory.
551552
552-
mods4pandas writes two output files: A pandas DataFrame (as Parquet) and a CSV file with all conversion warnings.
553+
mods4pandas writes two output files: A pandas DataFrame (in Parquet format)
554+
and a CSV file with all conversion warnings.
553555
554-
Per-page information (e.g. structure information) can be output to a separate Parquet file.
556+
Per-page information (e.g. structure information) can be output to a
557+
separate Parquet file.
555558
"""
556559
process(mets_files, output_file, output_page_info, mets_files_list)
557560

0 commit comments

Comments
 (0)