Skip to content

Commit

Permalink
corrected docstring formatting (don't ask...)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianMindee committed Jan 15, 2024
1 parent a4599ea commit 327b76b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 8 deletions.
15 changes: 10 additions & 5 deletions mindee/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -227,17 +227,22 @@ def enqueue_and_parse(
"""
Enqueues to an asynchronous endpoint and automatically polls for a response.
:param product_class: The document class to use. The response object will be instantiated based on this parameter.
:param product_class: The document class to use. The response object will be instantiated based on this\
parameter.
:param input_source: The document/source file to use. Has to be created beforehand.
:param include_words: Whether to include the full text for each page. This performs a full OCR operation on the server and will increase response time.
:param include_words: Whether to include the full text for each page. This performs a full OCR operation on\
the server and will increase response time.
:param close_file: Whether to ``close()`` the file after parsing it. Set to ``False`` if you need to access the file after this operation.
:param close_file: Whether to ``close()`` the file after parsing it. Set to ``False`` if you need to access\
the file after this operation.
:param page_options: If set, remove pages from the document as specified. This is done before sending the file to the server. It is useful to avoid page limitations.
:param page_options: If set, remove pages from the document as specified. This is done before sending the file\
to the server. It is useful to avoid page limitations.
:param cropper: Whether to include cropper results for each page. This performs a cropping operation on the server and will increase response time.
:param cropper: Whether to include cropper results for each page. This performs a cropping operation on the\
server and will increase response time.
:param endpoint: For custom endpoints, an endpoint has to be given.
Expand Down
2 changes: 1 addition & 1 deletion mindee/parsing/generated/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
from mindee.parsing.generated.generated_object import (
GeneratedObjectField,
is_generated_object,
)
)
2 changes: 1 addition & 1 deletion mindee/parsing/generated/generated_object.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def _str_level(self, level=0) -> str:
"confidence",
"raw_value",
]:
value = self.__getattribute__(attr)
value = getattr(self, attr)
str_value = str(value) if value is not None else ""
out_str += f"\n{indent}:{attr}: {str_value}"
return "\n" + indent + (out_str.strip())
Expand Down
2 changes: 1 addition & 1 deletion mindee/product/generated/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from mindee.product.generated.generated_v1 import (
GeneratedV1,
GeneratedV1Document,
GeneratedV1Page
GeneratedV1Page,
)

0 comments on commit 327b76b

Please sign in to comment.