♻️ typos & fixes (#205)

Author: sebastianMindee

docs/extras/guide/bank_check_v1.md

@@ -137,7 +137,7 @@ print(result.document.inference.prediction.check_number.value)
 [📄](#page-level-fields "This field is only present on individual pages.")**check_position** ([PositionField](#positionfield)): The position of the check on the document.
 
 ```py
-for check_position_elem of result.document.check_position:
+for check_position_elem in result.document.check_position:
     print(check_position_elem.polygon)
 ```
 
@@ -168,7 +168,7 @@ print(result.document.inference.prediction.routing_number.value)
 
 ```py
 for page in result.document.inference.pages:
-    for signatures_positions_elem of page.prediction.signatures_positions):
+    for signatures_positions_elem in page.prediction.signatures_positions):
         print(signatures_positions_elem.polygon)
 ```
 

docs/extras/guide/cropper_v1.md

@@ -91,7 +91,7 @@ The following fields are extracted for Cropper V1:
 
 ```py
 for page in result.document.inference.pages:
-    for cropping_elem of page.prediction.cropping):
+    for cropping_elem in page.prediction.cropping):
         print(cropping_elem.polygon)
 ```
 

docs/extras/guide/idcard_fr_v2.md

@@ -171,15 +171,15 @@ print(result.document.inference.prediction.document_number.value)
 [📄](#page-level-fields "This field is only present on individual pages.")**document_side** ([ClassificationField](#classificationfield)): The sides of the document which are visible.
 
 ```py
-for document_side_elem of result.document.document_side:
+for document_side_elem in result.document.document_side:
     print(document_side_elem.value)
 ```
 
 ## Document Type
 [📄](#page-level-fields "This field is only present on individual pages.")**document_type** ([ClassificationField](#classificationfield)): The document type or format.
 
 ```py
-for document_type_elem of result.document.document_type:
+for document_type_elem in result.document.document_type:
     print(document_type_elem.value)
 ```
 

docs/extras/guide/invoice_splitter_v1.md

@@ -84,7 +84,7 @@ The following fields are extracted for Invoice Splitter V1:
 **invoice_page_groups** ([InvoiceSplitterV1PageGroup](#invoice-splitter-v1-page-group)\[]): List of page indexes that belong to the same invoice in the PDF.
 
 ```py
-for invoice_page_groups_elem of page.prediction.invoice_page_groups):
+for invoice_page_groups_elem in page.prediction.invoice_page_groups):
     print(invoice_page_groups_elem.polygon)
 ```
 

docs/extras/guide/us_driver_license_v1.md

@@ -223,7 +223,7 @@ print(result.document.inference.prediction.last_name.value)
 [📄](#page-level-fields "This field is only present on individual pages.")**photo** ([PositionField](#positionfield)): Has a photo of the US driver license holder
 
 ```py
-for photo_elem of result.document.photo:
+for photo_elem in result.document.photo:
     print(photo_elem.polygon)
 ```
 
@@ -245,7 +245,7 @@ print(result.document.inference.prediction.sex.value)
 [📄](#page-level-fields "This field is only present on individual pages.")**signature** ([PositionField](#positionfield)): Has a signature of the US driver license holder
 
 ```py
-for signature_elem of result.document.signature:
+for signature_elem in result.document.signature:
     print(signature_elem.polygon)
 ```
 

docs/extras/guide/us_w9_v1.md

@@ -103,95 +103,95 @@ The following fields are extracted for W9 V1:
 [📄](#page-level-fields "This field is only present on individual pages.")**address** ([StringField](#stringfield)): The street address (number, street, and apt. or suite no.) of the applicant.
 
 ```py
-for address_elem of result.document.address:
+for address_elem in result.document.address:
     print(address_elem.value)
 ```
 
 ## Business Name
 [📄](#page-level-fields "This field is only present on individual pages.")**business_name** ([StringField](#stringfield)): The business name or disregarded entity name, if different from Name.
 
 ```py
-for business_name_elem of result.document.business_name:
+for business_name_elem in result.document.business_name:
     print(business_name_elem.value)
 ```
 
 ## City State Zip
 [📄](#page-level-fields "This field is only present on individual pages.")**city_state_zip** ([StringField](#stringfield)): The city, state, and ZIP code of the applicant.
 
 ```py
-for city_state_zip_elem of result.document.city_state_zip:
+for city_state_zip_elem in result.document.city_state_zip:
     print(city_state_zip_elem.value)
 ```
 
 ## EIN
 [📄](#page-level-fields "This field is only present on individual pages.")**ein** ([StringField](#stringfield)): The employer identification number.
 
 ```py
-for ein_elem of result.document.ein:
+for ein_elem in result.document.ein:
     print(ein_elem.value)
 ```
 
 ## Name
 [📄](#page-level-fields "This field is only present on individual pages.")**name** ([StringField](#stringfield)): Name as shown on the applicant's income tax return.
 
 ```py
-for name_elem of result.document.name:
+for name_elem in result.document.name:
     print(name_elem.value)
 ```
 
 ## Signature Date Position
 [📄](#page-level-fields "This field is only present on individual pages.")**signature_date_position** ([PositionField](#positionfield)): Position of the signature date on the document.
 
 ```py
-for signature_date_position_elem of result.document.signature_date_position:
+for signature_date_position_elem in result.document.signature_date_position:
     print(signature_date_position_elem.polygon)
 ```
 
 ## Signature Position
 [📄](#page-level-fields "This field is only present on individual pages.")**signature_position** ([PositionField](#positionfield)): Position of the signature on the document.
 
 ```py
-for signature_position_elem of result.document.signature_position:
+for signature_position_elem in result.document.signature_position:
     print(signature_position_elem.polygon)
 ```
 
 ## SSN
 [📄](#page-level-fields "This field is only present on individual pages.")**ssn** ([StringField](#stringfield)): The applicant's social security number.
 
 ```py
-for ssn_elem of result.document.ssn:
+for ssn_elem in result.document.ssn:
     print(ssn_elem.value)
 ```
 
 ## Tax Classification
 [📄](#page-level-fields "This field is only present on individual pages.")**tax_classification** ([StringField](#stringfield)): The federal tax classification, which can vary depending on the revision date.
 
 ```py
-for tax_classification_elem of result.document.tax_classification:
+for tax_classification_elem in result.document.tax_classification:
     print(tax_classification_elem.value)
 ```
 
 ## Tax Classification LLC
 [📄](#page-level-fields "This field is only present on individual pages.")**tax_classification_llc** ([StringField](#stringfield)): Depending on revision year, among S, C, P or D for Limited Liability Company Classification.
 
 ```py
-for tax_classification_llc_elem of result.document.tax_classification_llc:
+for tax_classification_llc_elem in result.document.tax_classification_llc:
     print(tax_classification_llc_elem.value)
 ```
 
 ## Tax Classification Other Details
 [📄](#page-level-fields "This field is only present on individual pages.")**tax_classification_other_details** ([StringField](#stringfield)): Tax Classification Other Details.
 
 ```py
-for tax_classification_other_details_elem of result.document.tax_classification_other_details:
+for tax_classification_other_details_elem in result.document.tax_classification_other_details:
     print(tax_classification_other_details_elem.value)
 ```
 
 ## W9 Revision Date
 [📄](#page-level-fields "This field is only present on individual pages.")**w9_revision_date** ([StringField](#stringfield)): The Revision month and year of the W9 form.
 
 ```py
-for w9_revision_date_elem of result.document.w9_revision_date:
+for w9_revision_date_elem in result.document.w9_revision_date:
     print(w9_revision_date_elem.value)
 ```
 

mindee/client.py

@@ -127,7 +127,7 @@ def enqueue(
         endpoint: Optional[Endpoint] = None,
     ) -> AsyncPredictResponse:
         """
-        Enqueueing to an async endpoint.
+        Enqueues a document to an asynchronous endpoint.
 
         :param product_class: The document class to use.
             The response object will be instantiated based on this parameter.
@@ -216,7 +216,7 @@ def enqueue_and_parse(
         max_retries: int = 10,
     ) -> AsyncPredictResponse:
         """
-        Enqueueing to an async endpoint.
+        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.

mindee/parsing/common/extras/cropper_extra.py

@@ -7,10 +7,12 @@
 class CropperExtra:
     """Contains information on the cropping of a prediction."""
 
+    croppings: List[PositionField]
+    """List of all cropping coordinates."""
+
     def __init__(
         self, raw_prediction: StringDict, page_id: Optional[int] = None
     ) -> None:
-        super().__init__()
         croppings: List[PositionField] = []
         if "cropping" in raw_prediction and raw_prediction["cropping"]:
             for cropping in raw_prediction["cropping"]:

mindee/parsing/custom/line_items.py

@@ -172,5 +172,4 @@ def get_line_items(
                     <= height_line_tolerance
                 ):
                     current_line.update_field(field_name, list_field_value)
-
     return lines_prepared

mindee/product/invoice/invoice_v4_line_item.py

@@ -74,7 +74,7 @@ def to_table_line(self) -> str:
         out_str += f"{printable['tax_amount']:<10} | "
         out_str += f"{printable['tax_rate']:<12} | "
         out_str += f"{printable['total_amount']:<12} | "
-        out_str += f"{printable['unit_price']:<10} | "
+        out_str += f"{printable['unit_price']:<10} |"
         return clean_out_string(out_str)
 
     def __str__(self) -> str: