Skip to content

Commit d37a265

Browse files
authored
style: add signature styling to Usage sections of all entry pages
Add .signature class and .signature-body div wrappers to the Usage sections of all 26 remaining entry pages to match the jQuery API documentation styling already applied to required-method.md, rules.md, and jQuery.validator.addClassRules.md. Files updated: - 12 simple method pages (min, max, range, etc.) - 7 empty-usage pages (Validator.destroy, valid, selectors, etc.) - 6 Validator/jQuery.validator pages - validate.md (complex options page)
1 parent 4d45846 commit d37a265

26 files changed

Lines changed: 189 additions & 2 deletions

_entries/Validator.destroy.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ This is only useful, when you need to clean up after the validator in a Single P
1717

1818
## Usage
1919

20+
### `Validator.destroy()`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
25+
This signature does not accept any arguments.
26+
27+
</div>
2028

2129
## Examples
2230

_entries/Validator.element.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,17 @@ This behaves as validation on blur or keyup, but returns the result.
1717

1818
## Usage
1919

20+
### `Validator.element( element )`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
2025
**element** *(Selector)*
2126

2227
An element to validate, must be inside the validated form.
2328

29+
</div>
30+
2431
## Examples
2532

2633
Triggers element validation programmatically.

_entries/Validator.form.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ This behaves as a normal submit event, but returns the result.
1717

1818
## Usage
1919

20+
### `Validator.form()`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
25+
This signature does not accept any arguments.
26+
27+
</div>
2028

2129
## Examples
2230

_entries/Validator.numberOfInvalids.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,14 @@ This depends on the internal validator state. It covers all fields only after va
1717

1818
## Usage
1919

20-
**errors** *(Object)*
20+
### `Validator.numberOfInvalids()`
21+
{:.signature}
2122

22-
One or more key/value pairs of input names and messages.
23+
<div class="signature-body" markdown="1">
24+
25+
This signature does not accept any arguments.
26+
27+
</div>
2328

2429
## Examples
2530

_entries/Validator.resetForm.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ Resets input fields to their original value (requires form plugin), removes clas
1717

1818
## Usage
1919

20+
### `Validator.resetForm()`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
25+
This signature does not accept any arguments.
26+
27+
</div>
2028

2129
## Examples
2230

_entries/Validator.showErrors.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,17 @@ Keys have to refer to the names of elements, values are displayed for those elem
1717

1818
## Usage
1919

20+
### `Validator.showErrors( errors )`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
2025
**errors** *(Object)*
2126

2227
One or more key/value pairs of input names and messages.
2328

29+
</div>
30+
2431
## Examples
2532

2633
Adds and shows error message programmatically.

_entries/accept-method.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,17 @@ Uses the HTML5 file API to look at the type attribute of one or more selected fi
1717

1818
## Usage
1919

20+
### `accept( mimetype )`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
2025
**mimetype** *(String)*
2126

2227
The allowed type, seperated via ",", defaults to "image/*"
2328

29+
</div>
30+
2431
## Examples
2532

2633
Required, only audio files allowed:

_entries/blank-selector.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ Blank means either no value at all or only whitespace. The implementation does a
1818

1919
## Usage
2020

21+
### `:blank Selector`
22+
{:.signature}
23+
24+
<div class="signature-body" markdown="1">
25+
26+
This signature does not accept any arguments.
27+
28+
</div>
2129

2230
## Examples
2331

_entries/equalTo-method.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,17 @@ Returns true if the value has the same value as the element specified by the fir
1818

1919
## Usage
2020

21+
### `equalTo( other )`
22+
{:.signature}
23+
24+
<div class="signature-body" markdown="1">
25+
2126
**other** *(Selector)*
2227

2328
The selector for the element to compare the current values
2429

30+
</div>
31+
2532
## Examples
2633

2734
Makes "field" required to be the same as #other

_entries/extension-method.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,17 @@ Returns true if the value ends with one of the specified file extensions. If not
1717

1818
## Usage
1919

20+
### `extension( extension )`
21+
{:.signature}
22+
23+
<div class="signature-body" markdown="1">
24+
2025
**extension** *(String)* (optional)
2126

2227
The allowed file extensions, seperated with "|" (or a comma, ","), defaults to "png|jpe?g|gif".
2328

29+
</div>
30+
2431
## Examples
2532

2633
Makes "field" required and ending with ".xls" or ".csv".

0 commit comments

Comments
 (0)