Skip to content

Commit 443d5aa

Browse files
authored
fix: convert 4-space indented callback params to Markdown lists in validate.md
Callback parameter descriptions were indented with 4+ spaces for visual hierarchy, but Markdown interprets this as code blocks. Converted all such sections to use nested unordered lists, which render correctly while preserving the visual structure.
1 parent 91db3ac commit 443d5aa

1 file changed

Lines changed: 21 additions & 75 deletions

File tree

_entries/validate.md

Lines changed: 21 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
5858

5959
The callback gets passed two arguments:
6060

61-
**form** *(Element)*
62-
63-
The form currently being validated, as a DOMElement.
64-
65-
**event** *(Event)*
66-
67-
The submit event instance.
61+
- **form** *(Element)* - The form currently being validated, as a DOMElement.
62+
- **event** *(Event)* - The submit event instance.
6863

6964
**invalidHandler** *(Function)*
7065

@@ -92,13 +87,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
9287

9388
The callback gets passed two arguments:
9489

95-
**event** *(Event)*
96-
97-
A custom event object, since this function is bound as an event handler.
98-
99-
**validator** *(Validator)*
100-
101-
The validator instance for the current form.
90+
- **event** *(Event)* - A custom event object, since this function is bound as an event handler.
91+
- **validator** *(Validator)* - The validator instance for the current form.
10292

10393
**ignore** *(Selector)* (default: `":hidden"`)
10494

@@ -264,13 +254,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
264254

265255
The callback gets passed two arguments:
266256

267-
**element** *(Element)*
268-
269-
The element currently being validated, as a DOMElement.
270-
271-
**event** *(Event)*
272-
273-
The event object for this focusout event.
257+
- **element** *(Element)* - The element currently being validated, as a DOMElement.
258+
- **event** *(Event)* - The event object for this focusout event.
274259

275260
**onkeyup** *(Boolean | Function)*
276261

@@ -286,13 +271,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
286271

287272
The callback gets passed two arguments:
288273

289-
**element** *(Element)*
290-
291-
The element currently being validated, as a DOMElement.
292-
293-
**event** *(Event)*
294-
295-
The event object for this keyup event.
274+
- **element** *(Element)* - The element currently being validated, as a DOMElement.
275+
- **event** *(Event)* - The event object for this keyup event.
296276

297277
**onclick** *(Boolean | Function)*
298278

@@ -308,13 +288,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
308288

309289
The callback gets passed two arguments:
310290

311-
**element** *(Element)*
312-
313-
The element currently being validated, as a DOMElement.
314-
315-
**event** *(Event)*
316-
317-
The event object for this click event.
291+
- **element** *(Element)* - The element currently being validated, as a DOMElement.
292+
- **event** *(Event)* - The event object for this click event.
318293

319294
**focusInvalid** *(Boolean)* (default: `true`)
320295

@@ -435,21 +410,10 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
435410

436411
The callback gets passed two arguments:
437412

438-
**errorMap** *(Object)*
439-
440-
Key/value pairs, where the key refers to the name of an input field, values the message to be displayed for that input.
441-
442-
**errorList** *(Array)*
443-
444-
An array for all currently validated elements. Contains objects with the following two properties:
445-
446-
**message** *(String)*
447-
448-
The message to be displayed for an input.
449-
450-
**element** *(Element)*
451-
452-
The DOMElement for this entry.
413+
- **errorMap** *(Object)* - Key/value pairs, where the key refers to the name of an input field, values the message to be displayed for that input.
414+
- **errorList** *(Array)* - An array for all currently validated elements. Contains objects with the following two properties:
415+
- **message** *(String)* - The message to be displayed for an input.
416+
- **element** *(Element)* - The DOMElement for this entry.
453417

454418
**errorPlacement** *(Function)* (default: `Places the error label after the invalid element`)
455419

@@ -467,13 +431,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
467431

468432
The callback gets passed two arguments:
469433

470-
**error** *(jQuery)*
471-
472-
The error label to insert into the DOM.
473-
474-
**element** *(jQuery)*
475-
476-
The validated input, for relative positioning.
434+
- **error** *(jQuery)* - The error label to insert into the DOM.
435+
- **element** *(jQuery)* - The validated input, for relative positioning.
477436

478437
**success** *(String | Function)*
479438

@@ -501,13 +460,8 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
501460

502461
The callback gets passed two arguments:
503462

504-
**label** *(jQuery)*
505-
506-
The error label. Use to add a class or replace the text content.
507-
508-
**element** *(Element)*
509-
510-
The element currently being validated, as a DOMElement.
463+
- **label** *(jQuery)* - The error label. Use to add a class or replace the text content.
464+
- **element** *(Element)* - The element currently being validated, as a DOMElement.
511465

512466
**highlight** *(Function)* (default: `Adds errorClass (see the option) to the element`)
513467

@@ -544,17 +498,9 @@ This method sets up event handlers for submit, focus, keyup, blur and click to t
544498

545499
The callback gets passed three arguments:
546500

547-
**element** *(Element)*
548-
549-
The invalid DOM element, usually an `input`.
550-
551-
**errorClass** *(String)*
552-
553-
Current value of the `errorClass` option.
554-
555-
**validClass** *(String)*
556-
557-
Current value of the `validClass` option.
501+
- **element** *(Element)* - The invalid DOM element, usually an `input`.
502+
- **errorClass** *(String)* - Current value of the `errorClass` option.
503+
- **validClass** *(String)* - Current value of the `validClass` option.
558504

559505
**unhighlight** *(Function)* (default: `Removes the errorClass`)
560506

0 commit comments

Comments
 (0)