diff options
| author | Michael Merickel <michael@merickel.org> | 2016-11-15 19:50:24 -0600 |
|---|---|---|
| committer | Michael Merickel <michael@merickel.org> | 2016-11-15 19:50:24 -0600 |
| commit | b13b1c8de94a55ac99865c06598743899806c689 (patch) | |
| tree | 7e5ce3c8d24048b1853a02f405469a51193dcace | |
| parent | 9c8d43a7101c2977f6bf388758f14c7c7fadcf71 (diff) | |
| download | pyramid-b13b1c8de94a55ac99865c06598743899806c689.tar.gz pyramid-b13b1c8de94a55ac99865c06598743899806c689.tar.bz2 pyramid-b13b1c8de94a55ac99865c06598743899806c689.zip | |
fix docstring on check_csrf_token
| -rw-r--r-- | pyramid/session.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/pyramid/session.py b/pyramid/session.py index d00902f2a..513628ce7 100644 --- a/pyramid/session.py +++ b/pyramid/session.py @@ -214,9 +214,9 @@ def check_csrf_token(request, supplied by ``request.session.get_csrf_token()``, and ``raises`` is ``True``, this function will raise an :exc:`pyramid.exceptions.BadCSRFToken` exception. - If the check does succeed and ``raises`` is ``False``, this - function will return ``False``. If the CSRF check is successful, this - function will return ``True`` unconditionally. + If the values differ and ``raises`` is ``False``, this function will + return ``False``. If the CSRF check is successful, this function will + return ``True`` unconditionally. Note that using this function requires that a :term:`session factory` is configured. |