summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2013-10-02 18:56:56 -0400
committerChris McDonough <chrism@plope.com>2013-10-02 18:56:56 -0400
commit96188ac4b74cb1e67cb95afdb9519ecd8934d688 (patch)
tree66bb56b03f2df802dd0836d017a59f993bcf86c8 /docs
parentaf2893269f563b856da06d4f90ae8b324ad2cadb (diff)
downloadpyramid-96188ac4b74cb1e67cb95afdb9519ecd8934d688.tar.gz
pyramid-96188ac4b74cb1e67cb95afdb9519ecd8934d688.tar.bz2
pyramid-96188ac4b74cb1e67cb95afdb9519ecd8934d688.zip
rearrange the fix
Diffstat (limited to 'docs')
-rw-r--r--docs/glossary.rst23
-rw-r--r--docs/narr/traversal.rst14
2 files changed, 19 insertions, 18 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst
index 398f945a4..406b81778 100644
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -505,15 +505,20 @@ Glossary
available as its ``__parent__`` attribute.
root factory
- The "root factory" of a :app:`Pyramid` application is called
- on every request sent to the application. The root factory
- returns the traversal root of an application. It is
- conventionally named ``get_root``. An application may supply a
- root factory to :app:`Pyramid` during the construction of a
- :term:`Configurator`. If a root factory is not supplied, the
- application uses a default root object. Use of the default root
- object is useful in application which use :term:`URL dispatch` for
- all URL-to-view code mappings.
+ The "root factory" of a :app:`Pyramid` application is called on every
+ request sent to the application. The root factory returns the traversal
+ root of an application. It is conventionally named ``get_root``. An
+ application may supply a root factory to :app:`Pyramid` during the
+ construction of a :term:`Configurator`. If a root factory is not
+ supplied, the application creates a default root object using the
+ :term:`default root factory`.
+
+ default root factory
+ If an application does not register a :term:`root factory` at Pyramid
+ configuration time, a *default* root factory is used to created the
+ default root object. Use of the default root object is useful in
+ application which use :term:`URL dispatch` for all URL-to-view code
+ mappings, and does not (knowingly) use traversal otherwise.
SQLAlchemy
`SQLAlchemy <http://www.sqlalchemy.org/>`_ is an object
diff --git a/docs/narr/traversal.rst b/docs/narr/traversal.rst
index fb4adff61..454bb5620 100644
--- a/docs/narr/traversal.rst
+++ b/docs/narr/traversal.rst
@@ -128,12 +128,6 @@ Here's an example of a simple root factory class:
def __init__(self, request):
pass
-..note::
- For the purpose of understanding traversal, and the contents within
- this document, the above Root is an analogue to the default root
- factory present in Pyramid. The default root factory is very simple and
- not very useful unless using :term:`URL dispatch`.
-
Here's an example of using this root factory within startup configuration, by
passing it to an instance of a :term:`Configurator` named ``config``:
@@ -152,13 +146,15 @@ refer to a root factory defined in a different module.
If no :term:`root factory` is passed to the :app:`Pyramid`
:term:`Configurator` constructor, or if the ``root_factory`` value
-specified is ``None``, a *default* root factory is used. The default
+specified is ``None``, a :term:`default root factory` is used. The default
root factory always returns a resource that has no child resources; it
is effectively empty.
Usually a root factory for a traversal-based application will be more
-complicated than the above ``Root`` class; in particular it may be
-associated with a database connection or another persistence mechanism.
+complicated than the above ``Root`` class; in particular it may be associated
+with a database connection or another persistence mechanism. The above
+``Root`` class is analogous to the default root factory present in Pyramid. The
+default root factory is very simple and not very useful.
.. note::