Update CLI helpdoc formatting to allow indentation in code

Use `textwrap.dedent()` to allow indented cli-helpdoc in `__main__.py` file. The indentation increases readability, while `textwrap.dedent` helps maintain the same functionality without breaking code.
This commit is contained in:
Sugato Ray
2024-12-18 14:22:58 -05:00
committed by GitHub
parent 1deaba1c6c
commit 39410d01df

View File

@@ -3,6 +3,7 @@
# SPDX-License-Identifier: MIT # SPDX-License-Identifier: MIT
import sys import sys
import argparse import argparse
from textwrap import dedent
from ._markitdown import MarkItDown from ._markitdown import MarkItDown
@@ -10,24 +11,24 @@ def main():
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
description="Convert various file formats to markdown.", description="Convert various file formats to markdown.",
formatter_class=argparse.RawDescriptionHelpFormatter, formatter_class=argparse.RawDescriptionHelpFormatter,
usage=""" usage=dedent("""
SYNTAX: SYNTAX:
markitdown <OPTIONAL: FILENAME> markitdown <OPTIONAL: FILENAME>
If FILENAME is empty, markitdown reads from stdin. If FILENAME is empty, markitdown reads from stdin.
EXAMPLE: EXAMPLE:
markitdown example.pdf markitdown example.pdf
OR OR
cat example.pdf | markitdown cat example.pdf | markitdown
OR OR
markitdown < example.pdf markitdown < example.pdf
""".strip(), """).strip(),
) )
parser.add_argument("filename", nargs="?") parser.add_argument("filename", nargs="?")