~speijnik/python-argvalidate/devel

« back to all changes in this revision

Viewing changes to doc/envvars.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-envvars:
 
2
 
 
3
argvalidate environment variables
 
4
=================================
 
5
 
 
6
argvalidate lets you control its behaviour via two environment variables.
 
7
 
 
8
These variables are documented below.
 
9
 
 
10
.. envvar:: ARGVALIDATE_WARN
 
11
 
 
12
Defines whether argvalidate should raise exceptions on errors (value: `0`, 
 
13
default) or whether warnings should be generated (value: non-`0`).
 
14
 
 
15
.. note::
 
16
 
 
17
   The unit tests shipping with argvalidate turn off warnings so they can
 
18
   check if the respective exceptions have been raised.
 
19
 
 
20
.. envvar:: ARGVALIDATE_WARN_KWARG_AS_ARG
 
21
 
 
22
Defines whether argvalidate should generate a warning if a keyword argument
 
23
has been passed as a non-keyword argument (value: non-`0`) or not (value: `0`,
 
24
default).
 
25