From b13b1c8de94a55ac99865c06598743899806c689 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Tue, 15 Nov 2016 19:50:24 -0600 Subject: fix docstring on check_csrf_token --- pyramid/session.py | 6 +++--- 1 file 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. -- cgit v1.2.3