Unverified Commit acd0deb1 authored by shniubobo's avatar shniubobo
Browse files

docs(web_api): Change docstrings style

parent 3b98efbb
...@@ -164,21 +164,21 @@ async def pdf_parse( ...@@ -164,21 +164,21 @@ async def pdf_parse(
Execute the process of converting PDF to JSON and MD, outputting MD and JSON files Execute the process of converting PDF to JSON and MD, outputting MD and JSON files
to the specified directory. to the specified directory.
:param pdf_file: The PDF file to be parsed. Must not be specified together with Args:
`pdf_path` pdf_file: The PDF file to be parsed. Must not be specified together with
:param pdf_path: The path to the PDF file to be parsed. Must not be specified `pdf_path`
together with `pdf_file` pdf_path: The path to the PDF file to be parsed. Must not be specified together
:param parse_method: Parsing method, can be auto, ocr, or txt. Default is auto. If with `pdf_file`
results are not satisfactory, try ocr parse_method: Parsing method, can be auto, ocr, or txt. Default is auto. If
:param is_json_md_dump: Whether to write parsed data to .json and .md files. Default results are not satisfactory, try ocr
to False. Different stages of data will be written to different .json files (3 is_json_md_dump: Whether to write parsed data to .json and .md files. Default
in total), md content will be saved to .md file to False. Different stages of data will be written to different .json files
:param output_dir: Output directory for results. A folder named after the PDF file (3 in total), md content will be saved to .md file
will be created to store all results output_dir: Output directory for results. A folder named after the PDF file
:param return_layout: Whether to return parsed PDF layout. Default to False will be created to store all results
:param return_info: Whether to return parsed PDF info. Default to False return_layout: Whether to return parsed PDF layout. Default to False
:param return_content_list: Whether to return parsed PDF content list. Default to return_info: Whether to return parsed PDF info. Default to False
False return_content_list: Whether to return parsed PDF content list. Default to False
""" """
try: try:
if (pdf_file is None and pdf_path is None) or ( if (pdf_file is None and pdf_path is None) or (
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment