Skip to content

Commit bcc45b5

Browse files
fix typos in md documentation
1 parent 7e106bc commit bcc45b5

3 files changed

Lines changed: 17 additions & 50 deletions

File tree

docs/financial_document_v1.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -241,14 +241,14 @@ Aside from the previous attributes, all basic fields have access to a custom `to
241241
### AddressField
242242
Aside from the basic `BaseField` attributes, the address field `AddressField` also implements the following:
243243

244-
* **streetNumber** (`string`): String representation of the string number. Can be `null`.
245-
* **streetName** (`string`): Name of the street. Can be `null`.
246-
* **poBox** (`string`): String representation of the PO Box number. Can be `null`.
247-
* **addressComplement** (`string`): Address complement. Can be `null`.
248-
* **city** (`string`): City name. Can be `null`.
249-
* **postalcode** (`string`): String representation of the postal code. Can be `null`.
250-
* **state** (`string`): State name. Can be `null`.
251-
* **country** (`string`): Country name. Can be `null`.
244+
* **streetNumber** (`String`): String representation of the street number. Can be `null`.
245+
* **streetName** (`String`): Name of the street. Can be `null`.
246+
* **poBox** (`String`): String representation of the PO Box number. Can be `null`.
247+
* **addressComplement** (`String`): Address complement. Can be `null`.
248+
* **city** (`String`): City name. Can be `null`.
249+
* **postalcode** (`String`): String representation of the postal code. Can be `null`.
250+
* **state** (`String`): State name. Can be `null`.
251+
* **country** (`String`): Country name. Can be `null`.
252252

253253
Note: The `value` field of an AddressField should be a concatenation of the rest of the values.
254254

docs/invoices_v4.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -233,14 +233,14 @@ Aside from the previous attributes, all basic fields have access to a custom `to
233233
### AddressField
234234
Aside from the basic `BaseField` attributes, the address field `AddressField` also implements the following:
235235

236-
* **streetNumber** (`string`): String representation of the string number. Can be `null`.
237-
* **streetName** (`string`): Name of the street. Can be `null`.
238-
* **poBox** (`string`): String representation of the PO Box number. Can be `null`.
239-
* **addressComplement** (`string`): Address complement. Can be `null`.
240-
* **city** (`string`): City name. Can be `null`.
241-
* **postalcode** (`string`): String representation of the postal code. Can be `null`.
242-
* **state** (`string`): State name. Can be `null`.
243-
* **country** (`string`): Country name. Can be `null`.
236+
* **streetNumber** (`String`): String representation of the street number. Can be `null`.
237+
* **streetName** (`String`): Name of the street. Can be `null`.
238+
* **poBox** (`String`): String representation of the PO Box number. Can be `null`.
239+
* **addressComplement** (`String`): Address complement. Can be `null`.
240+
* **city** (`String`): City name. Can be `null`.
241+
* **postalcode** (`String`): String representation of the postal code. Can be `null`.
242+
* **state** (`String`): State name. Can be `null`.
243+
* **country** (`String`): Country name. Can be `null`.
244244

245245
Note: The `value` field of an AddressField should be a concatenation of the rest of the values.
246246

docs/us_mail_v3.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parentDoc: 631a062c3718850f3519b793
66
---
77
The Java OCR SDK supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
88

9-
Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
9+
The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg) can be used for testing purposes.
1010
![US Mail sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg?raw=true)
1111

1212
# Quick-Start
@@ -54,39 +54,6 @@ public class SimpleMindeeClient {
5454
}
5555

5656
```
57-
58-
**Output (RST):**
59-
```rst
60-
########
61-
Document
62-
########
63-
:Mindee ID: f9c36f59-977d-4ddc-9f2d-31c294c456ac
64-
:Filename: default_sample.jpg
65-
66-
Inference
67-
#########
68-
:Product: mindee/us_mail v3.0
69-
:Rotation applied: Yes
70-
71-
Prediction
72-
==========
73-
:Sender Name: company zed
74-
:Sender Address:
75-
:City: Dallas
76-
:Complete Address: 54321 Elm Street, Dallas, Texas 54321
77-
:Postal Code: 54321
78-
:State: TX
79-
:Street: 54321 Elm Street
80-
:Recipient Names: Jane Doe
81-
:Recipient Addresses:
82-
+-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
83-
| City | Complete Address | Is Address Change | Postal Code | Private Mailbox Number | State | Street | Unit |
84-
+=================+=====================================+===================+=============+========================+=======+===========================+=================+
85-
| Detroit | 1234 Market Street PMB 4321, Det... | False | 12345 | 4321 | MI | 1234 Market Street | |
86-
+-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
87-
:Return to Sender: False
88-
```
89-
9057
# Field Types
9158
## Standard Fields
9259
These fields are generic and used in several products.

0 commit comments

Comments
 (0)