diff options
| author | Chris McDonough <chrism@agendaless.com> | 2009-05-14 02:53:03 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2009-05-14 02:53:03 +0000 |
| commit | 8525cfd9c5509d8c4c61cc1d2463486be7f01dad (patch) | |
| tree | 38e48a83d29e7cbacb528c1dc432c610aa018d4c /docs | |
| parent | d68aa53b21452aac914b1cabbf59df25503f00a2 (diff) | |
| download | pyramid-8525cfd9c5509d8c4c61cc1d2463486be7f01dad.tar.gz pyramid-8525cfd9c5509d8c4c61cc1d2463486be7f01dad.tar.bz2 pyramid-8525cfd9c5509d8c4c61cc1d2463486be7f01dad.zip | |
- Added API docs for the ``repoze.bfg.testing`` methods
``registerAdapter``, ``registerUtiity``, ``registerSubscriber``, and
``cleanUp``.
- Added glossary entry for "root factory".
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/testing.rst | 8 | ||||
| -rw-r--r-- | docs/glossary.rst | 10 |
2 files changed, 18 insertions, 0 deletions
diff --git a/docs/api/testing.rst b/docs/api/testing.rst index 9aebc7d30..7870ed1d3 100644 --- a/docs/api/testing.rst +++ b/docs/api/testing.rst @@ -17,6 +17,14 @@ .. autofunction:: registerViewPermission + .. autofunction:: registerUtility + + .. autofunction:: registerAdapter + + .. autofunction:: registerSubscriber + + .. autofunction:: cleanUp + .. autoclass:: DummyModel :members: diff --git a/docs/glossary.rst b/docs/glossary.rst index b55f8395c..6d4d83f51 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -338,3 +338,13 @@ Glossary itself, its parent, its parent's parent, and so on. The order of the sequence is context-first, then the parent of the context, then its parent's parent, and so on. + Root Factory + The "root factory" of an :mod:`repoze.bfg` 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 must supply a + root factory to :mod:`repoze.bfg` within a call to + ``repoze.bfg.router.make_app``; however, an application's root + factory may be passed to ``make_app`` as ``None``, in which case + the application performs no graph traversal and uses :term:`URL + dispatch` for all URL-to-view code mappings. |
