Skip to content

Commit 3ee94b9

Browse files
lemonezlemonez
authored
Update validators.rst
fix small typos/misspellings
1 parent 7bc9cbb commit 3ee94b9

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

‎docs/validators.rst

+42-42
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Validators availables
2-
=====================
1+
Validators available
2+
====================
33

44

5-
At the moment, the library support this validations:
5+
At the moment, the library supports these validations:
66

77
* Types
88

@@ -16,7 +16,7 @@ At the moment, the library support this validations:
1616
* :ref:`in_length`
1717
* :ref:`in_nan`
1818

19-
* Comparision
19+
* Comparison
2020

2121
* :ref:`in_lesser`
2222
* :ref:`in_lesser_equal`
@@ -57,7 +57,7 @@ ValidateInteger
5757

5858
Check if the new value is a valid ``int`` or ``long`` type
5959

60-
Parametes:
60+
Parameters:
6161

6262
+-------------------------+-----------+-----------------------------------------------------------------+
6363
| Parameter | Default | Description |
@@ -71,7 +71,7 @@ Parametes:
7171
| message | None | Add a custom message to the ``ValidateError`` exception |
7272
+-------------------------+-----------+-----------------------------------------------------------------+
7373

74-
.. note:: ``long`` type is only available i Python 2.7
74+
.. note:: ``long`` type is only available in Python 2.7
7575

7676

7777
.. _in_numeric:
@@ -82,7 +82,7 @@ ValidateNumeric
8282
Check if the new value is a valid ``int``, ``long``, ``float`` or ``complex`` type
8383

8484

85-
Parametes:
85+
Parameters:
8686

8787
+-------------------------+----------+-----------------------------------------------------------------+
8888
| Parameter | Default | Description |
@@ -108,7 +108,7 @@ ValidateString
108108

109109
Check if the new value is a valid ``string`` type.
110110

111-
Parametes:
111+
Parameters:
112112

113113
+-------------------------+----------+-----------------------------------------------------------------+
114114
| Parameter | Default | Description |
@@ -131,7 +131,7 @@ ValidateBoolean
131131

132132
Check if the new value is a valid ``bool`` type.
133133

134-
Parametes:
134+
Parameters:
135135

136136
+-------------------------+----------+-----------------------------------------------------------------+
137137
| Parameter | Default | Description |
@@ -150,9 +150,9 @@ Parametes:
150150
Validatelength
151151
--------------
152152

153-
Check if the new value has a length with a maximun and a minimun
153+
Check if the new value has a length with a maximum and a minimum
154154

155-
Parametes:
155+
Parameters:
156156

157157
+-------------------------+----------+-----------------------------------------------------------------+
158158
| Parameter | Default | Description |
@@ -161,7 +161,7 @@ Parametes:
161161
+-------------------------+----------+-----------------------------------------------------------------+
162162
| max_length | None | Maximum value length |
163163
+-------------------------+----------+-----------------------------------------------------------------+
164-
| min_length | 0 | Minumum value length |
164+
| min_length | 0 | Minimum value length |
165165
+-------------------------+----------+-----------------------------------------------------------------+
166166
| throw_exception | False | Throw a ``ValidateError`` exception on validation fails |
167167
+-------------------------+----------+-----------------------------------------------------------------+
@@ -176,7 +176,7 @@ ValidateNumber
176176

177177
Check if the new value is a number or not (NaN)
178178

179-
Parametes:
179+
Parameters:
180180

181181
+-------------------------+----------+-----------------------------------------------------------------+
182182
| Parameter | Default | Description |
@@ -194,9 +194,9 @@ Parametes:
194194
ValidateLessThan
195195
----------------
196196

197-
Check if the new value is a lesser than X value
197+
Check if the new value is less than the value of X
198198

199-
Parametes:
199+
Parameters:
200200

201201
+-------------------------+----------+-----------------------------------------------------------------+
202202
| Parameter | Default | Description |
@@ -217,9 +217,9 @@ Parametes:
217217
ValidateLessThanOrEqual
218218
-----------------------
219219

220-
Check if the new value is a lesser than X value or equal
220+
Check if the new value is less than or equal to the value of X
221221

222-
Parametes:
222+
Parameters:
223223

224224
+-------------------------+----------+-----------------------------------------------------------------+
225225
| Parameter | Default | Description |
@@ -239,9 +239,9 @@ Parametes:
239239
ValidateGreaterThan
240240
-------------------
241241

242-
Check if the new value is a greater than X value
242+
Check if the new value is greater than the value of X
243243

244-
Parametes:
244+
Parameters:
245245

246246
+-------------------------+----------+-----------------------------------------------------------------+
247247
| Parameter | Default | Description |
@@ -262,9 +262,9 @@ Parametes:
262262
ValidateGreaterThanOrEqual
263263
--------------------------
264264

265-
Check if the new value is a greater than X value or equal
265+
Check if the new value is greater than or equal to the value of X
266266

267-
Parametes:
267+
Parameters:
268268

269269
+-------------------------+----------+-----------------------------------------------------------------+
270270
| Parameter | Default | Description |
@@ -285,20 +285,20 @@ Parametes:
285285
ValidateEmail
286286
-------------
287287

288-
Check if the new value is a valid e-mail, using email_validator_ library.
288+
Check if the new value is a valid e-mail, using the email_validator_ library.
289289

290-
Parametes:
290+
Parameters:
291291

292292
+-------------------------+----------+--------------------------------------------------------------------------------+
293293
| Parameter | Default | Description |
294294
+=========================+==========+================================================================================+
295295
| field | | SQLAlchemy column to validate |
296296
+-------------------------+----------+--------------------------------------------------------------------------------+
297-
| allow_smtputf8 | True | Allow internationalized addresses that would require the SMTPUTF8_ extension. |
297+
| allow_smtputf8 | True | Allow internationalized addresses that would require the SMTPUTF8_ extension |
298298
+-------------------------+----------+--------------------------------------------------------------------------------+
299-
| check_deliverability | True | Check domain name resolution. |
299+
| check_deliverability | True | Check domain name resolution |
300300
+-------------------------+----------+--------------------------------------------------------------------------------+
301-
| allow_empty_local | False | Allow an empty local part for validating Postfix aliases. |
301+
| allow_empty_local | False | Allow an empty local part for validating Postfix aliases |
302302
+-------------------------+----------+--------------------------------------------------------------------------------+
303303
| allow_null | True | Allow ``null`` values |
304304
+-------------------------+----------+--------------------------------------------------------------------------------+
@@ -315,9 +315,9 @@ Parametes:
315315
ValidateRegex
316316
-------------
317317

318-
Compare a value against a regular expresion
318+
Compare a value against a regular expression
319319

320-
Parametes:
320+
Parameters:
321321

322322
+-------------------------+-----------+-----------------------------------------------------------------+
323323
| Parameter | Default | Description |
@@ -337,7 +337,7 @@ ValidateRange
337337

338338
Check if the new value is in a range
339339

340-
Parametes:
340+
Parameters:
341341

342342
+-------------------------+-----------+-----------------------------------------------------------------+
343343
| Parameter | Default | Description |
@@ -361,7 +361,7 @@ ValidateIP
361361

362362
Check if the value is a valid IP Address
363363

364-
Parametes:
364+
Parameters:
365365

366366
+-------------------------+-----------+-----------------------------------------------------------------+
367367
| Parameter | Default | Description |
@@ -385,7 +385,7 @@ ValidateURL
385385

386386
Check if the value is a valid URL
387387

388-
Parametes:
388+
Parameters:
389389

390390
+-------------------------+-----------+-----------------------------------------------------------------+
391391
| Parameter | Default | Description |
@@ -408,7 +408,7 @@ ValidateUUID
408408

409409
Check if the value is a valid UUUID
410410

411-
Parametes:
411+
Parameters:
412412

413413
+-------------------------+-----------+-----------------------------------------------------------------+
414414
| Parameter | Default | Description |
@@ -439,7 +439,7 @@ Check if the value is a valid Country. Validation provided by iso3166_. Allowed
439439
* Numeric
440440
* Apolitic Name
441441

442-
Parametes:
442+
Parameters:
443443

444444
+-------------------------+-----------+-----------------------------------------------------------------+
445445
| Parameter | Default | Description |
@@ -462,7 +462,7 @@ ValidateTimezone
462462
Check if the value is a valid Timezone. Validation provided by pytz_
463463

464464

465-
Parametes:
465+
Parameters:
466466

467467
+-------------------------+-----------+-----------------------------------------------------------------+
468468
| Parameter | Default | Description |
@@ -486,7 +486,7 @@ ValidateLocale
486486
Check if the value is a valid Locale.
487487

488488

489-
Parametes:
489+
Parameters:
490490

491491
+-------------------------+-----------+-----------------------------------------------------------------+
492492
| Parameter | Default | Description |
@@ -516,7 +516,7 @@ Allowed formats:
516516
* "XXXX-YYYY-WWWW-ZZZ"
517517

518518

519-
Parametes:
519+
Parameters:
520520

521521
+-------------------------+-----------+-----------------------------------------------------------------+
522522
| Parameter | Default | Description |
@@ -542,7 +542,7 @@ Check if the new value is a valid Currency
542542
Validation provided by: moneyed_
543543

544544

545-
Parametes:
545+
Parameters:
546546

547547
+-------------------------+-----------+-----------------------------------------------------------------+
548548
| Parameter | Default | Description |
@@ -563,13 +563,13 @@ Parametes:
563563
ValidateIBAN
564564
------------
565565

566-
Check if the new value is valid IBAN (International Bank Account Number)
566+
Check if the new value is a valid IBAN (International Bank Account Number)
567567

568568
More reference: https://en.wikipedia.org/wiki/International_Bank_Account_Number
569569

570570

571571

572-
Parametes:
572+
Parameters:
573573

574574
+-------------------------+-----------+-----------------------------------------------------------------+
575575
| Parameter | Default | Description |
@@ -589,13 +589,13 @@ Parametes:
589589
ValidateBIC
590590
------------
591591

592-
Check if the new value is valid BIC (SO 9362 defined standard format of Bank Identifier Codes )
592+
Check if the new value is a valid BIC (SO 9362 defined standard format of Bank Identifier Codes)
593593

594594
More reference: https://en.wikipedia.org/wiki/ISO_9362
595595

596596

597597

598-
Parametes:
598+
Parameters:
599599

600600
+-------------------------+-----------+-----------------------------------------------------------------+
601601
| Parameter | Default | Description |
@@ -624,7 +624,7 @@ More reference: https://en.wikipedia.org/wiki/International_Standard_Book_Number
624624

625625

626626

627-
Parametes:
627+
Parameters:
628628

629629
+-------------------------+-----------+-----------------------------------------------------------------+
630630
| Parameter | Default | Description |

0 commit comments

Comments
 (0)