From 1de5ec90e0ecb81ee1f4c4ade0b11c2cc8cf646a Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 19 Jan 2010 03:34:51 +0000 Subject: Spellcheck. --- docs/zcml/repozewho1authenticatiohnpolicy.rst | 53 --------------------------- docs/zcml/repozewho1authenticationpolicy.rst | 53 +++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 53 deletions(-) delete mode 100644 docs/zcml/repozewho1authenticatiohnpolicy.rst create mode 100644 docs/zcml/repozewho1authenticationpolicy.rst (limited to 'docs/zcml') diff --git a/docs/zcml/repozewho1authenticatiohnpolicy.rst b/docs/zcml/repozewho1authenticatiohnpolicy.rst deleted file mode 100644 index 62713e822..000000000 --- a/docs/zcml/repozewho1authenticatiohnpolicy.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _repozewho1authenticationpolicy_directive: - -``repozewho1authenticationpolicy`` ----------------------------------- - -When this directive is used, authentication information is obtained -from a ``repoze.who.identity`` key in the WSGI environment, assumed to -be set by :term:`repoze.who` middleware. - -Attributes -~~~~~~~~~~ - -``identifier_name`` - The ``identifier_name`` controls the name used to look up the - :term:`repoze.who` "identifier" plugin within - ``request.environ['repoze.who.plugins']`` which is used by this - policy to "remember" and "forget" credentials. It defaults to - ``auth_tkt``. - -``callback`` - The ``callback`` is a Python dotted name to a function passed the - repoze.who identity and the request as positional arguments. The - callback is expected to return None if the user represented by the - identity doesn't exist or a sequence of group identifiers - (possibly empty) if the user does exist. If ``callback`` is None, - the userid will be assumed to exist with no groups. It defaults - to ``None``. - -Example -~~~~~~~ - -.. code-block:: xml - :linenos: - - - -Alternatives -~~~~~~~~~~~~ - -You may create an instance of the -:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy` and -pass it to the :class:`repoze.bfg.configuration.Configurator` -constructor as the ``authentication_policy`` argument during initial -application configuration. - -See Also -~~~~~~~~ - -See also :ref:`authentication_policies_directives_section` and -:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy`. diff --git a/docs/zcml/repozewho1authenticationpolicy.rst b/docs/zcml/repozewho1authenticationpolicy.rst new file mode 100644 index 000000000..62713e822 --- /dev/null +++ b/docs/zcml/repozewho1authenticationpolicy.rst @@ -0,0 +1,53 @@ +.. _repozewho1authenticationpolicy_directive: + +``repozewho1authenticationpolicy`` +---------------------------------- + +When this directive is used, authentication information is obtained +from a ``repoze.who.identity`` key in the WSGI environment, assumed to +be set by :term:`repoze.who` middleware. + +Attributes +~~~~~~~~~~ + +``identifier_name`` + The ``identifier_name`` controls the name used to look up the + :term:`repoze.who` "identifier" plugin within + ``request.environ['repoze.who.plugins']`` which is used by this + policy to "remember" and "forget" credentials. It defaults to + ``auth_tkt``. + +``callback`` + The ``callback`` is a Python dotted name to a function passed the + repoze.who identity and the request as positional arguments. The + callback is expected to return None if the user represented by the + identity doesn't exist or a sequence of group identifiers + (possibly empty) if the user does exist. If ``callback`` is None, + the userid will be assumed to exist with no groups. It defaults + to ``None``. + +Example +~~~~~~~ + +.. code-block:: xml + :linenos: + + + +Alternatives +~~~~~~~~~~~~ + +You may create an instance of the +:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy` and +pass it to the :class:`repoze.bfg.configuration.Configurator` +constructor as the ``authentication_policy`` argument during initial +application configuration. + +See Also +~~~~~~~~ + +See also :ref:`authentication_policies_directives_section` and +:class:`repoze.bfg.authentication.RepozeWho1AuthenticationPolicy`. -- cgit v1.2.3