From fd0f6308c840ab5d5712d4b51e47d51bc2809167 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 3 Jul 2009 14:06:56 +0000 Subject: API docs audit. --- repoze/bfg/router.py | 26 -------------------------- repoze/bfg/wsgi.py | 4 ++-- 2 files changed, 2 insertions(+), 28 deletions(-) (limited to 'repoze') diff --git a/repoze/bfg/router.py b/repoze/bfg/router.py index ac8a1faaa..c89296837 100644 --- a/repoze/bfg/router.py +++ b/repoze/bfg/router.py @@ -242,32 +242,6 @@ def make_app(root_factory, package=None, filename='configure.zcml', dictionary, the value passed as ``filename`` will be ignored, replaced with the ``configure_zcml`` value. - ``authentication_policy`` should be an object that implements the - ``repoze.bfg.interfaces.IAuthenticationPolicy`` interface (e.g. - it might be an instance of - ``repoze.bfg.authentication.RemoteUserAuthenticationPolicy``) or - ``None``. If ``authentication_policy`` is ``None``, no - authentication or authorization will be performed. Instead, BFG - will ignore any view permission assertions in your application and - imperative security checks performed by your application will - always return ``True``. This argument is deprecated in - :mod:`repoze.bfg` 1.0; use a ZCML directive such as - ``authtktauthenticationpolicy`` instead, as documented in the - Security chapter of the :mod:`repoze.bfg` documentation. - - ``authorization_policy`` is an object that implements the - ``repoze.bfg.interfaces.IAuthorizationPoicy`` interface - (notionally) or ``None``. If the ``authentication_policy`` - argument is ``None``, this argument is ignored entirely because - being able to authorize access to a user depends on being able to - authenticate that user. If the ``authentication_policy`` argument - is *not* ``None``, and the ``authorization_policy`` argument *is* - ``None``, the authorization policy defaults to an authorization - implementation that uses ACLs. This argument is deprecated in - :mod:`repoze.bfg` 1.0; use a ZCML directive such as - ``aclauthorizationpolicy`` instead, as documented in the Security - chapter of the :mod:`repoze.bfg` documentation. - ``options``, if used, should be a dictionary containing runtime options (e.g. the key/value pairs in an app section of a PasteDeploy file), with each key representing the option and the diff --git a/repoze/bfg/wsgi.py b/repoze/bfg/wsgi.py index 545b3e93c..cb68567ba 100644 --- a/repoze/bfg/wsgi.py +++ b/repoze/bfg/wsgi.py @@ -8,7 +8,7 @@ from repoze.bfg.traversal import quote_path_segment def wsgiapp(wrapped): """ Decorator to turn a WSGI application into a repoze.bfg view - callable. This decorator differs from the `wsgiapp2`` decorator + callable. This decorator differs from the ``wsgiapp2`` decorator inasmuch as fixups of ``PATH_INFO`` and ``SCRIPT_NAME`` within the WSGI environment *are not* performed before the application is invoked. @@ -41,7 +41,7 @@ def wsgiapp(wrapped): def wsgiapp2(wrapped): """ Decorator to turn a WSGI application into a repoze.bfg view - callable. This decorator differs from the `wsgiapp`` decorator + callable. This decorator differs from the ``wsgiapp`` decorator inasmuch as fixups of ``PATH_INFO`` and ``SCRIPT_NAME`` within the WSGI environment *are* performed before the application is invoked. -- cgit v1.2.3