summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorkennyballou <kballou@onyx.boisestate.edu>2013-03-09 18:22:33 -0700
committerkennyballou <kballou@onyx.boisestate.edu>2013-03-09 18:22:33 -0700
commit53069d8212a5e87802ca9535191e8cb056d9a787 (patch)
tree793e288dd5771eb3f65783d6acac79e4d57aa274 /docs
parentaeb0672db3f2a4ddb4812344398831180a723d0c (diff)
downloadxnt-53069d8212a5e87802ca9535191e8cb056d9a787.tar.gz
xnt-53069d8212a5e87802ca9535191e8cb056d9a787.tar.xz
Use uppercase properties for dictionary value
After using pylint I noticed I should have Xnt also use this for the override properties dictionary [http://www.python.org/dev/peps/pep-0008/#constants]
Diffstat (limited to 'docs')
-rw-r--r--docs/source/buildfile.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/source/buildfile.rst b/docs/source/buildfile.rst
index cec8e30..8200fff 100644
--- a/docs/source/buildfile.rst
+++ b/docs/source/buildfile.rst
@@ -134,16 +134,16 @@ Build Properties
As mentioned in :ref:`xntPropertiesParameters`, Xnt can accept parameters from
the command line and pass them into the build file. Xnt doesn't necessarily
-expect the dictionary (named `properties`) to exist; but if you ever intend to
+expect the dictionary (named `PROPERTIES`) to exist; but if you ever intend to
use it, it will have to be defined one way or another (either to an empty
dictionary or actually hold values). For example, to define an empty
-`properties` dictionary, one could write their build file as such::
+`PROPERTIES` dictionary, one could write their build file as such::
#!/usr/bin/env python
from xnt import target
- properties = {}
+ PROPERTIES = {}
@target
def foo():