[Repoze-checkins] r1454 - in repoze.bfg/trunk/docs: . narr

[Paul Everitt]

Author: Paul Everitt <paul at agendaless.com>
Date: Thu Jul 24 16:25:31 2008
New Revision: 1454

Log:
More glossary, add some text to project explanation

Modified:
   repoze.bfg/trunk/docs/glossary.rst
   repoze.bfg/trunk/docs/narr/project.rst

Modified: repoze.bfg/trunk/docs/glossary.rst
==============================================================================
--- repoze.bfg/trunk/docs/glossary.rst	(original)
+++ repoze.bfg/trunk/docs/glossary.rst	Thu Jul 24 16:25:31 2008
@@ -24,6 +24,11 @@
     The "URL name" of a view, e.g "index.html".  If a view is
     configured without a name, its name is considered to be the empty
     string (which implies the "default view").
+  virtualenv
+    An isolated Python environment.  Allows you to control which
+    packages are used on a particular project by cloning your main
+    Python.  `virtualenv <http://pypi.python.org/pypi/virtualenv>`_
+    was created by Ian Bicking.
   model
     An object representing data in the system.  A model is part of the
     object graph traversed by the system.  Models are traversed to

Modified: repoze.bfg/trunk/docs/narr/project.rst
==============================================================================
--- repoze.bfg/trunk/docs/narr/project.rst	(original)
+++ repoze.bfg/trunk/docs/narr/project.rst	Thu Jul 24 16:25:31 2008
@@ -68,7 +68,7 @@
    Finished processing dependencies for myproject==0.1
 
 This will install your application 's package into the interpreter so
-it can be found and run under a webserver.
+it can be found and run as a WSGI application inside a WSGI server.
 
 Running The Tests For Your Application
 --------------------------------------
@@ -241,9 +241,16 @@
    hop in the URL.  (That data comes from the model.)  The request is
    an instance of a WebOb request.
 
-#. The model renders a remplate and returns the result as the
+#. The model renders a template and returns the result as the
    response.
 
+.. note::
+
+  This example uses ``render_template_to_response`` which allows the
+  view author to think only in terms of templates.  If you want more
+  control over the response, use ``render_template`` and create your
+  own WebOb Response object to return.
+
 ``models.py``
 ~~~~~~~~~~~~~
 
@@ -275,9 +282,10 @@
 ``run.py``
 ~~~~~~~~~~
 
-We need a small Python module that sets everything, fires up a web
-server, and handles incoming requests.  Later we'll see how to use a
-Paste configuration file to do this work for us.
+We need a small Python module that configures our application and
+advertises itself to our Paste ``.ini`` file.  For convenience, we
+also make it possible to run this module directory without the Paste
+configuration file:
 
 .. literalinclude:: myproject/myproject/run.py
    :linenos: