summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2013-10-30 20:19:23 -0400
committerChris McDonough <chrism@plope.com>2013-10-30 20:19:23 -0400
commita91c19837f5ce579ce2a5bf68ddee30cfaebe034 (patch)
tree63dbeec2a430b0ec62d717490c1cb3e20b7a5667 /docs
parente1838557e6721b5b42f1267b134b626099703c2c (diff)
downloadpyramid-a91c19837f5ce579ce2a5bf68ddee30cfaebe034.tar.gz
pyramid-a91c19837f5ce579ce2a5bf68ddee30cfaebe034.tar.bz2
pyramid-a91c19837f5ce579ce2a5bf68ddee30cfaebe034.zip
note deprecation
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/threadlocals.rst19
1 files changed, 9 insertions, 10 deletions
diff --git a/docs/narr/threadlocals.rst b/docs/narr/threadlocals.rst
index a90ee4905..afe56de3e 100644
--- a/docs/narr/threadlocals.rst
+++ b/docs/narr/threadlocals.rst
@@ -29,17 +29,16 @@ of a thread local or a global is usually just a way to avoid passing
some value around between functions, which is itself usually a very
bad idea, at least if code readability counts as an important concern.
-For historical reasons, however, thread local variables are indeed
-consulted by various :app:`Pyramid` API functions. For example,
-the implementation of the :mod:`pyramid.security` function named
-:func:`~pyramid.security.authenticated_userid` retrieves the thread
-local :term:`application registry` as a matter of course to find an
+For historical reasons, however, thread local variables are indeed consulted by
+various :app:`Pyramid` API functions. For example, the implementation of the
+:mod:`pyramid.security` function named
+:func:`~pyramid.security.authenticated_userid` (deprecated as of 1.5) retrieves
+the thread local :term:`application registry` as a matter of course to find an
:term:`authentication policy`. It uses the
-:func:`pyramid.threadlocal.get_current_registry` function to
-retrieve the application registry, from which it looks up the
-authentication policy; it then uses the authentication policy to
-retrieve the authenticated user id. This is how :app:`Pyramid`
-allows arbitrary authentication policies to be "plugged in".
+:func:`pyramid.threadlocal.get_current_registry` function to retrieve the
+application registry, from which it looks up the authentication policy; it then
+uses the authentication policy to retrieve the authenticated user id. This is
+how :app:`Pyramid` allows arbitrary authentication policies to be "plugged in".
When they need to do so, :app:`Pyramid` internals use two API
functions to retrieve the :term:`request` and :term:`application