@@ -12,7 +12,7 @@ The Basics
12
12
The simplest way to validate an instance under a given schema is to use the
13
13
:func: `validate ` function.
14
14
15
- .. function :: validate
15
+ .. autofunction :: validate
16
16
17
17
Validate an ``instance `` under the given ``schema ``.
18
18
@@ -258,7 +258,7 @@ any use for them. They are listed below, along with any limitations they come
258
258
with.
259
259
260
260
261
- .. function :: is_date
261
+ .. autofunction :: is_date
262
262
263
263
Check if the instance is a date in ``YYYY-MM-DD `` format.
264
264
@@ -269,7 +269,7 @@ with.
269
269
>>> is_date(" 0000-13-32" )
270
270
False
271
271
272
- .. function :: is_time
272
+ .. autofunction :: is_time
273
273
274
274
Check if the instance is a time in ``hh:mm:ss `` format.
275
275
@@ -280,7 +280,7 @@ with.
280
280
>>> is_time(" 59:60:61" )
281
281
False
282
282
283
- .. function :: is_regex
283
+ .. autofunction :: is_regex
284
284
285
285
Check if the instance is a well-formed regular expression.
286
286
@@ -289,7 +289,7 @@ with.
289
289
>>> is_ipv6(" ^(bob?cat$" )
290
290
False
291
291
292
- .. function :: is_uri
292
+ .. autofunction :: is_uri
293
293
294
294
Check if the instance is a valid URI.
295
295
@@ -304,7 +304,7 @@ with.
304
304
>>> is_uri(" #/properties/foo" )
305
305
True
306
306
307
- .. function :: is_email
307
+ .. autofunction :: is_email
308
308
309
309
Check if the instance is a valid e-mail address.
310
310
@@ -317,7 +317,7 @@ with.
317
317
318
318
.. _RFC 2822 : http://tools.ietf.org/html/rfc2822
319
319
320
- .. function :: is_host_name
320
+ .. autofunction :: is_host_name
321
321
322
322
Check if the instance is a valid host name.
323
323
@@ -336,7 +336,7 @@ with.
336
336
>>> is_host_name(" www.example.doesnotexist" )
337
337
True
338
338
339
- .. function :: is_ip_address
339
+ .. autofunction :: is_ip_address
340
340
341
341
Check if the instance is a valid IP address.
342
342
@@ -350,7 +350,7 @@ with.
350
350
On OSes with the ``socket.inet_pton `` function, an additional checker for
351
351
``ipv6 `` will be enabled:
352
352
353
- .. function :: is_ipv6
353
+ .. function :: is_ipv6(instance)
354
354
355
355
Check if the instance is a valid IPv6 address.
356
356
@@ -364,7 +364,7 @@ On OSes with the ``socket.inet_pton`` function, an additional checker for
364
364
365
365
If the isodate _ library is present, a date-time checker will also be present.
366
366
367
- .. function :: is_date_time
367
+ .. function :: is_date_time(instance)
368
368
369
369
Check if the instance is in ISO 8601 ``YYYY-MM-DDThh:mm:ssZ `` format.
370
370
@@ -377,7 +377,7 @@ If the isodate_ library is present, a date-time checker will also be present.
377
377
Additionally, if the webcolors _ library is present, some checkers related to
378
378
CSS will be enabled:
379
379
380
- .. function :: is_css21_color
380
+ .. function :: is_css21_color(instance)
381
381
382
382
Check if the instance is a valid CSS 2.1 color name or code.
383
383
@@ -388,7 +388,7 @@ CSS will be enabled:
388
388
>>> is_css_color_code(" #CC8899" )
389
389
True
390
390
391
- .. function :: is_css3_color
391
+ .. function :: is_css3_color(instance)
392
392
393
393
Check if the instance is a valid CSS 3 color name or code.
394
394
0 commit comments