From d0d5f7af2fed9268084bd826703a053144cfaca3 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Thu, 23 Feb 2017 07:38:04 -0800 Subject: [PATCH] Add missing documentation for secretutils The current doc page for secretutils is blank [1], most likely because of the way constant_time_compare is in the exception block. This patch manually tells sphinx to doc the constant_time_compare function. Also adds the oslo.utils version when the module was added. [1]: https://docs.openstack.org/developer/oslo.utils/api/secretutils.html Change-Id: Ic1fb15176c93f126826f568149cabf4b8e5450d8 --- doc/source/api/secretutils.rst | 2 +- oslo_utils/secretutils.py | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/api/secretutils.rst b/doc/source/api/secretutils.rst index fb88a0c4..3e9f9438 100644 --- a/doc/source/api/secretutils.rst +++ b/doc/source/api/secretutils.rst @@ -3,4 +3,4 @@ ============= .. automodule:: oslo_utils.secretutils - :members: + :members: constant_time_compare diff --git a/oslo_utils/secretutils.py b/oslo_utils/secretutils.py index fd5c3171..84e0d69b 100644 --- a/oslo_utils/secretutils.py +++ b/oslo_utils/secretutils.py @@ -12,6 +12,12 @@ # License for the specific language governing permissions and limitations # under the License. +""" +Secret utilities. + +.. versionadded:: 3.5 +""" + import hmac