Skip to content
This repository was archived by the owner on Feb 12, 2020. It is now read-only.

Commit 334edf9

Browse files
committed
update doc
1 parent d32342f commit 334edf9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This method can be used to retrieve all errors for a given form, or an error for
5454
| Type | Name | Description |
5555
| ---- | ---- | ----------- |
5656
| *string* | formName | The name of the form. |
57-
| *string* *optional* | fieldName | The name of the field. |
57+
| *string* (optional) | fieldName | The name of the field. |
5858

5959
#### Returns
6060

@@ -81,13 +81,13 @@ For the purposes of this plugin, a "touch" occurs when a field receives input or
8181
| Type | Name | Description |
8282
| ---- | ---- | ----------- |
8383
| *string* | formName | The name of the form. |
84-
| *string* *optional* | fieldName | The name of the field. |
84+
| *string* (optional) | fieldName | The name of the field. |
8585

8686
#### Returns
8787

8888
When only `formName` is passed, the method returns `TRUE` if any of its fields have been touched, otherwise `FALSE`.
8989

90-
When `fieldName` is passed, `TRUE` or `FALSE` are returned based on the specific state of the field.
90+
When `fieldName` is passed, `TRUE` or `FALSE` are returned based on the state of the specific field.
9191

9292
#### Example
9393

@@ -208,7 +208,7 @@ Note: this can be used independently of any form or field elements.
208208
| Type | Name | Description | Default |
209209
| ---- | ---- | ----------- | ------- |
210210
| *string* | phone | Phone number. | |
211-
| *string* *optional* | country | A country code. | `US` |
211+
| *string* (optional) | country | A country code. | `US` |
212212

213213
#### Returns
214214

@@ -251,7 +251,7 @@ Find a Gravatar image URL for a given email address.
251251
| Type | Name | Description | Default |
252252
| ---- | ---- | ----------- | ------- |
253253
| *string* | email | Email address. | |
254-
| *string* *optional* | Size | The pixel size to return. | `80` |
254+
| *string* (optional) | Size | The pixel size to return. | `80` |
255255

256256
#### Returns
257257

0 commit comments

Comments
 (0)