summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Variables/PathVariable.py
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2017-09-01 02:57:51 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2017-09-01 02:57:51 (GMT)
commit29e9530300108c91ba446921bcdc95595a445245 (patch)
tree7f2a3a36201d9548ce6f62e742a467e07b7d8422 /src/engine/SCons/Variables/PathVariable.py
parent37dfc19d9bb694d80c1bc97d79e519a6d90bcaba (diff)
downloadSCons-29e9530300108c91ba446921bcdc95595a445245.zip
SCons-29e9530300108c91ba446921bcdc95595a445245.tar.gz
SCons-29e9530300108c91ba446921bcdc95595a445245.tar.bz2
Fix many epydoc warnings
Diffstat (limited to 'src/engine/SCons/Variables/PathVariable.py')
-rw-r--r--src/engine/SCons/Variables/PathVariable.py9
1 files changed, 4 insertions, 5 deletions
diff --git a/src/engine/SCons/Variables/PathVariable.py b/src/engine/SCons/Variables/PathVariable.py
index e615a53..0ffcbc5 100644
--- a/src/engine/SCons/Variables/PathVariable.py
+++ b/src/engine/SCons/Variables/PathVariable.py
@@ -8,8 +8,7 @@ Arguments to PathVariable are:
option-name = name of this option on the command line (e.g. "prefix")
option-help = help string for option
option-dflt = default value for this option
- validator = [optional] validator for option value. Predefined
- validators are:
+ validator = [optional] validator for option value. Predefined validators are:
PathAccept -- accepts any path setting; no validation
PathIsDir -- path must be an existing directory
@@ -25,7 +24,7 @@ Arguments to PathVariable are:
and the env is the env to which the Options have been
added.
-Usage example:
+Usage example::
Examples:
prefix=/usr/local
@@ -34,8 +33,8 @@ Usage example:
opts = Variables()
opts.Add(PathVariable('qtdir',
- 'where the root of Qt is installed',
- qtdir, PathIsDir))
+ 'where the root of Qt is installed',
+ qtdir, PathIsDir))
opts.Add(PathVariable('qt_includes',
'where the Qt includes are installed',
'$qtdir/includes', PathIsDirCreate))