summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-07-20 19:03:26 -0400
committerChris McDonough <chrism@plope.com>2011-07-20 19:03:26 -0400
commit5adf4c099905cb41f68b38d6443bd2fe62c76889 (patch)
tree46bf15eb0f56bdafd90409ab714e5b7b4adbcedc
parent0bac345c6ff595302e765dfce9bd91e198d61038 (diff)
downloadpyramid-5adf4c099905cb41f68b38d6443bd2fe62c76889.tar.gz
pyramid-5adf4c099905cb41f68b38d6443bd2fe62c76889.tar.bz2
pyramid-5adf4c099905cb41f68b38d6443bd2fe62c76889.zip
add description of keys and values
-rw-r--r--docs/narr/commandline.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/narr/commandline.rst b/docs/narr/commandline.rst
index a6ba99e17..f4cf951ba 100644
--- a/docs/narr/commandline.rst
+++ b/docs/narr/commandline.rst
@@ -192,10 +192,11 @@ Extending the Shell
~~~~~~~~~~~~~~~~~~~
It is sometimes convenient when using the interactive shell often to have
-some variables significant to your application already loaded as globals
-when you start the ``pshell``. To facilitate this, ``pshell`` will look
-for a special ``[pshell]`` section in your INI file and expose the subsequent
-key/value pairs to the shell.
+some variables significant to your application already loaded as globals when
+you start the ``pshell``. To facilitate this, ``pshell`` will look for a
+special ``[pshell]`` section in your INI file and expose the subsequent
+key/value pairs to the shell. Each key is a variable name that will be
+global within the pshell session; each value is a :term:`dotted Python name`.
For example, you want to expose your model to the shell, along with the
database session so that you can mutate the model on an actual database.