diff options
| author | Pavlo Kapyshin <i@93z.org> | 2015-01-07 19:10:31 +0200 |
|---|---|---|
| committer | Pavlo Kapyshin <i@93z.org> | 2015-01-07 19:10:31 +0200 |
| commit | 47e85294779814f14e02327eb4d378197bbaeb29 (patch) | |
| tree | ecfd5935b55a5f8afc536ed0a89c65e3437ee0f5 | |
| parent | 3702ab07e835a06f30abf5ceb626f81114115062 (diff) | |
| download | pyramid-47e85294779814f14e02327eb4d378197bbaeb29.tar.gz pyramid-47e85294779814f14e02327eb4d378197bbaeb29.tar.bz2 pyramid-47e85294779814f14e02327eb4d378197bbaeb29.zip | |
Provide a ref to check_csrf_token
| -rw-r--r-- | docs/narr/sessions.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/narr/sessions.rst b/docs/narr/sessions.rst index f20a36d81..5c103405a 100644 --- a/docs/narr/sessions.rst +++ b/docs/narr/sessions.rst @@ -380,7 +380,7 @@ Checking CSRF Tokens Manually ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In request handling code, you can check the presence and validity of a CSRF -token with ``pyramid.session.check_csrf_token(request)``. If the token is +token with :func:`pyramid.session.check_csrf_token`. If the token is valid, it will return ``True``, otherwise it will raise ``HTTPBadRequest``. Optionally, you can specify ``raises=False`` to have the check return ``False`` instead of raising an exception. |
