From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 6 Jun 2022 16:54:04 +0000 (-0700)
Subject: 📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396... 
X-Git-Tag: v3.10.6~193^2~4
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3d190513864bbb21529f49c858c4f8aa11dac9d0;p=thirdparty%2FPython%2Fcpython.git

📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) (#93400)

This is purely for SEO as this is the actual generic name for this kind of method and it currently does not appear in a Google search for "python constant time compare". Not creating an issue or setting this up for backports as its trivial (I think) and not a functional change.
(cherry picked from commit 8241a6971e6051ba10040af6b50f9236faa0c892)

Co-authored-by: Noah Kantrowitz <noah@coderanger.net>
---

diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst
index c22da727b55c..eda4616da5ec 100644
--- a/Doc/library/secrets.rst
+++ b/Doc/library/secrets.rst
@@ -129,7 +129,7 @@ Other functions
 .. function:: compare_digest(a, b)
 
    Return ``True`` if strings *a* and *b* are equal, otherwise ``False``,
-   in such a way as to reduce the risk of
+   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.