[Python-checkins] gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)

[miss-islington]

https://github.com/python/cpython/commit/47d673d81fc315069c14f9438ebe61fb70ef1ccc
commit: 47d673d81fc315069c14f9438ebe61fb70ef1ccc
branch: main
author: Nikita Sobolev <mail at sobolevn.me>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-11-26T01:33:48-08:00
summary:

gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)



Now it is in sync with https://docs.python.org/3/library/hmac.html#hmac.compare_digest
It is the same function, just re-exported. So, I guess they should mention the same input types.

files:
M Doc/library/secrets.rst

diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst
index dc8e5f46fb58..4405dfc05359 100644
--- a/Doc/library/secrets.rst
+++ b/Doc/library/secrets.rst
@@ -128,7 +128,9 @@ Other functions
 
 .. function:: compare_digest(a, b)
 
-   Return ``True`` if strings *a* and *b* are equal, otherwise ``False``,
+   Return ``True`` if strings or
+   :term:`bytes-like objects <bytes-like object>`
+   *a* and *b* are equal, otherwise ``False``,
    using a "constant-time compare" to reduce the risk of
    `timing attacks <https://codahale.com/a-lesson-in-timing-attacks/>`_.
    See :func:`hmac.compare_digest` for additional details.