~speijnik/python-argvalidate/devel

« back to all changes in this revision

Viewing changes to doc/index.rst

  • Committer: Stephan Peijnik
  • Date: 2010-04-23 18:10:11 UTC
  • Revision ID: debian@sp.or.at-20100423181011-u1uo3ui7do6qw7gm
Initial import from HG tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
argvalidate - Python argument validator library documentation
 
2
===========================================================================
 
3
 
 
4
Contents:
 
5
 
 
6
.. toctree::
 
7
   :maxdepth: 2
 
8
 
 
9
   argvalidate
 
10
   envvars
 
11
 
 
12
Primer
 
13
======
 
14
 
 
15
argvalidate is a small Python module which gives developers the opportunity
 
16
to do both argument- and return-value type checking.
 
17
This basically enables you to be sure that an argument passed to a function and
 
18
the return value of a function is of a specific type, or even one of a list 
 
19
specified types.
 
20
 
 
21
argvalidate provides you with two different decorators, which define the
 
22
rules for argument types and return value types: 
 
23
 
 
24
:func:`~argvalidate.accepts` and
 
25
:func:`~argvalidate.returns`.
 
26
 
 
27
argvalidate either raises an :ref:`exception <argvalidate-exceptions>` or
 
28
creates a Python warning if it detects an error. This behaviour can be
 
29
configured via :ref:`environment variables <argvalidate-envvars>`.
 
30
 
 
31
Reporting bugs
 
32
==============
 
33
 
 
34
If you find any bugs in argvalidate, have comments, suggestions or feature
 
35
requests, please use the `project homepage <http://code.sp-its.at/projects/argvalidate>`_.
 
36
 
 
37
 
 
38
Indices and tables
 
39
==================
 
40
 
 
41
* :ref:`genindex`
 
42
* :ref:`modindex`
 
43
* :ref:`search`
 
44