From a47a4e809be62c93deaed85088c4287c025fb177 Mon Sep 17 00:00:00 2001 From: David Kemp Date: Mon, 9 May 2016 17:50:04 -0400 Subject: [PATCH] Update jose.py Docstring for sign() has two instances of :parameter. All other functions use :param. Fix for consistency, and for compliance with http://docs.ckan.org/en/latest/contributing/python.html#sphinx-field-lists. --- jose.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/jose.py b/jose.py index c0043b8..013ffd5 100644 --- a/jose.py +++ b/jose.py @@ -460,9 +460,9 @@ def sign(claims, jwk, add_header=None, alg='HS256'): :class:`~jose.JWS`. :param jwk: A `dict` representing the JWK to be used for signing of the :class:`~jose.JWS`. This parameter is algorithm-specific. - :parameter add_header: Additional items to be added to the header. + :param add_header: Additional items to be added to the header. Additional headers *will* be authenticated. - :parameter alg: The algorithm to use to produce the signature. + :param alg: The algorithm to use to produce the signature. :rtype: :class:`~jose.JWS` """ (hash_fn, _), mod = JWA[alg]