summaryrefslogtreecommitdiff
path: root/repoze/bfg/scripting.py
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-12-24 01:26:37 +0000
committerChris McDonough <chrism@agendaless.com>2009-12-24 01:26:37 +0000
commitc6895b23b63365a983cf564fc67446913ef2bebd (patch)
tree1b679908dcf9a360f3250603eb8fedd23f46a144 /repoze/bfg/scripting.py
parent18e5d6c8fe922bf23ccbd481d60de294d7671103 (diff)
downloadpyramid-c6895b23b63365a983cf564fc67446913ef2bebd.tar.gz
pyramid-c6895b23b63365a983cf564fc67446913ef2bebd.tar.bz2
pyramid-c6895b23b63365a983cf564fc67446913ef2bebd.zip
Roles.
Diffstat (limited to 'repoze/bfg/scripting.py')
-rw-r--r--repoze/bfg/scripting.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/repoze/bfg/scripting.py b/repoze/bfg/scripting.py
index 3e743524a..b6f7ed97f 100644
--- a/repoze/bfg/scripting.py
+++ b/repoze/bfg/scripting.py
@@ -2,13 +2,13 @@ from repoze.bfg.request import Request
def get_root(app, request=None):
""" Return a tuple composed of ``(root, closer)`` when provided a
- ``repoze.bfg.router.Router`` instance as the ``app`` argument.
- The ``root`` returned is the application root object. The
- ``closer`` returned is a callable (accepting no arguments) that
- should be called when your scripting application is finished using
- the root. If ``request`` is not None, it is used as the request
- passed to the :mod:`repoze.bfg` application root factory. A
- request is constructed and passed to the root factory if
+ :class:`repoze.bfg.router.Router` instance as the ``app``
+ argument. The ``root`` returned is the application root object.
+ The ``closer`` returned is a callable (accepting no arguments)
+ that should be called when your scripting application is finished
+ using the root. If ``request`` is not None, it is used as the
+ request passed to the :mod:`repoze.bfg` application root factory.
+ A request is constructed and passed to the root factory if
``request`` is None."""
registry = app.registry
if request is None: