diff options
Diffstat (limited to 'repoze/bfg/scripting.py')
| -rw-r--r-- | repoze/bfg/scripting.py | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/repoze/bfg/scripting.py b/repoze/bfg/scripting.py index b6f7ed97f..8547eae62 100644 --- a/repoze/bfg/scripting.py +++ b/repoze/bfg/scripting.py @@ -2,14 +2,13 @@ from repoze.bfg.request import Request def get_root(app, request=None): """ Return a tuple composed of ``(root, closer)`` when provided a - :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.""" + :term:`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: request = Request.blank('/') |