summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2010-04-18 21:54:20 +0000
committerChris McDonough <chrism@agendaless.com>2010-04-18 21:54:20 +0000
commite6fa66bd2c18632ef0608c63fb024b01931a5272 (patch)
tree6c1df278eb35dc9dff725b62c2387183d63ba5f5 /docs
parentc91eff7524189db9152260ff5c8db1c40672ad55 (diff)
downloadpyramid-e6fa66bd2c18632ef0608c63fb024b01931a5272.tar.gz
pyramid-e6fa66bd2c18632ef0608c63fb024b01931a5272.tar.bz2
pyramid-e6fa66bd2c18632ef0608c63fb024b01931a5272.zip
- Use "Venusian" (`http://docs.repoze.org/venusian
<http://docs.repoze.org/venusian>`) to perform ``bfg_view`` decorator scanning rather than relying on a BFG-internal decorator scanner. (Truth be told, Venusian is really just a generalization of the BFG-internal decorator scanner). - A new install-time dependency on the ``venusian`` distribution was added. - Remove ``repoze.bfg.compat.pkgutil_26.py`` and import alias ``repoze.bfg.compat.walk_packages``. These were only required by internal scanning machinery; Venusian replaced the internal scanning machinery, so these are no longer required.
Diffstat (limited to 'docs')
-rw-r--r--docs/api/configuration.rst2
-rw-r--r--docs/glossary.rst7
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/api/configuration.rst b/docs/api/configuration.rst
index eeea605b2..e872a91b9 100644
--- a/docs/api/configuration.rst
+++ b/docs/api/configuration.rst
@@ -40,7 +40,7 @@
.. automethod:: override_resource(to_override, override_with)
- .. automethod:: scan(package)
+ .. automethod:: scan(package=None, categories=None)
.. automethod:: set_forbidden_view(view=None, attr=None, renderer=None, wrapper=None)
diff --git a/docs/glossary.rst b/docs/glossary.rst
index 2915ff5f3..14bd4fc44 100644
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -660,3 +660,10 @@ Glossary
"GAE") is a Python application hosting service offered by Google.
:mod:`repoze.bfg` runs on GAE.
+ Venusian
+ `Venusian <http://docs.repoze.org/venusian>`_ is a library which
+ allows framework authors to defer decorator actions. Instead of
+ taking actions when a function (or class) decorator is executed
+ at import time, the action usually taken by the decorator is
+ deferred until a separate "scan" phase. :mod:`repoze.bfg` relies
+ on Venusian to provide a basis for its :term:`scan` feature.