]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] Fix extraneous backslashes in hashlib docs (GH-109468) (#109531)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 18 Sep 2023 07:34:20 +0000 (00:34 -0700)
committerGitHub <noreply@github.com>
Mon, 18 Sep 2023 07:34:20 +0000 (07:34 +0000)
Fix extraneous backslashes in hashlib docs (GH-109468)
(cherry picked from commit ce5b3e19e6fb940fa72db1b98a8df80f6e464265)

Co-authored-by: Anthony Sottile <asottile@umich.edu>
Doc/library/hashlib.rst

index c77b728dbf3056c4afba988296461bd975bcadfd..957d51978d6d599f483699a328e2c400b89d1541 100644 (file)
@@ -131,16 +131,16 @@ Using :func:`new` with an algorithm name:
    '031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
 
 
-.. function:: md5([, data], \*, usedforsecurity=True)
-.. function:: sha1([, data], \*, usedforsecurity=True)
-.. function:: sha224([, data], \*, usedforsecurity=True)
-.. function:: sha256([, data], \*, usedforsecurity=True)
-.. function:: sha384([, data], \*, usedforsecurity=True)
-.. function:: sha512([, data], \*, usedforsecurity=True)
-.. function:: sha3_224([, data], \*, usedforsecurity=True)
-.. function:: sha3_256([, data], \*, usedforsecurity=True)
-.. function:: sha3_384([, data], \*, usedforsecurity=True)
-.. function:: sha3_512([, data], \*, usedforsecurity=True)
+.. function:: md5([, data], *, usedforsecurity=True)
+.. function:: sha1([, data], *, usedforsecurity=True)
+.. function:: sha224([, data], *, usedforsecurity=True)
+.. function:: sha256([, data], *, usedforsecurity=True)
+.. function:: sha384([, data], *, usedforsecurity=True)
+.. function:: sha512([, data], *, usedforsecurity=True)
+.. function:: sha3_224([, data], *, usedforsecurity=True)
+.. function:: sha3_256([, data], *, usedforsecurity=True)
+.. function:: sha3_384([, data], *, usedforsecurity=True)
+.. function:: sha3_512([, data], *, usedforsecurity=True)
 
 Named constructors such as these are faster than passing an algorithm name to
 :func:`new`.
@@ -234,8 +234,8 @@ A hash object has the following methods:
 SHAKE variable length digests
 -----------------------------
 
-.. function:: shake_128([, data], \*, usedforsecurity=True)
-.. function:: shake_256([, data], \*, usedforsecurity=True)
+.. function:: shake_128([, data], *, usedforsecurity=True)
+.. function:: shake_256([, data], *, usedforsecurity=True)
 
 The :func:`shake_128` and :func:`shake_256` algorithms provide variable
 length digests with length_in_bits//2 up to 128 or 256 bits of security.