openstack/oslo.utils
Code Issues Proposed changes

Add missing documentation for secretutils

Browse Source 
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
This commit is contained in:
Eric Brown 2017-02-23 07:38:04 -08:00
parent d74b933801
commit d0d5f7af2f
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/api/secretutils.rst
View File

@ -3,4 +3,4 @@
=============
.. automodule:: oslo_utils.secretutils
:members:
:members: constant_time_compare

6
oslo_utils/secretutils.py
View File

@ -12,6 +12,12 @@
# License for the specific language governing permissions and limitations
# under the License.
"""
Secret utilities.
.. versionadded:: 3.5
"""
import hmac