From 488292a84e22a31052d9966d8198c728a074c4b2 Mon Sep 17 00:00:00 2001 From: Nicolas Stuhlfauth Date: Mon, 9 Jul 2018 09:24:42 +0200 Subject: [PATCH] Changed docstrings for set_access_cookies and set_refresh_cookies. Improves documentation. Resolves #161 --- flask_jwt_extended/utils.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/flask_jwt_extended/utils.py b/flask_jwt_extended/utils.py index 1e13f35c..1b87cc1f 100644 --- a/flask_jwt_extended/utils.py +++ b/flask_jwt_extended/utils.py @@ -205,7 +205,7 @@ def set_access_cookies(response, encoded_access_token, max_age=None): :param encoded_access_token: The encoded access token to set in the cookies. :param max_age: The max age of the cookie. If this is None, it will use the `JWT_SESSION_COOKIE` option (see :ref:`Configuration Options`). - Otherwise, it will use this as the cookies `max-age`. + Otherwise, it will use this as the cookies `max-age` and the JWT_SESSION_COOKIE option will be ignored. Values should be the number of seconds (as an integer). """ if not config.jwt_in_cookies: @@ -245,7 +245,7 @@ def set_refresh_cookies(response, encoded_refresh_token, max_age=None): :param encoded_refresh_token: The encoded refresh token to set in the cookies. :param max_age: The max age of the cookie. If this is None, it will use the `JWT_SESSION_COOKIE` option (see :ref:`Configuration Options`). - Otherwise, it will use this as the cookies `max-age`. + Otherwise, it will use this as the cookies `max-age` and the JWT_SESSION_COOKIE option will be ignored. Values should be the number of seconds (as an integer). """ if not config.jwt_in_cookies: