gh-132983: Fix docstrings in ``ZstdDict`` (#137321)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

diff --git a/Modules/_zstd/clinic/zstddict.c.h b/Modules/_zstd/clinic/zstddict.c.h
index 79db85405d6e6b6cadbad9fe635297520910aa4b..166d925a542352d6acee368c9da4ef5213a89d78 100644 (file)
--- a/Modules/_zstd/clinic/zstddict.c.h
+++ b/Modules/_zstd/clinic/zstddict.c.h
@@ -198,7 +198,7 @@ PyDoc_STRVAR(_zstd_ZstdDict_as_prefix__doc__,
 "1. Prefix is compatible with long distance matching, while dictionary is not.\n"
 "2. It only works for the first frame, then the compressor/decompressor will\n"
 "   return to no prefix state.\n"
-"3. When decompressing, must use the same prefix as when compressing.\"");
+"3. When decompressing, must use the same prefix as when compressing.");
 #if defined(_zstd_ZstdDict_as_prefix_DOCSTR)
 #   undef _zstd_ZstdDict_as_prefix_DOCSTR
 #endif
@@ -222,4 +222,4 @@ _zstd_ZstdDict_as_prefix_get(PyObject *self, void *Py_UNUSED(context))
 {
     return _zstd_ZstdDict_as_prefix_get_impl((ZstdDict *)self);
 }
-/*[clinic end generated code: output=4696cbc722e5fdfc input=a9049054013a1b77]*/
+/*[clinic end generated code: output=f41d9e2e2cc2928f input=a9049054013a1b77]*/

diff --git a/Modules/_zstd/zstddict.c b/Modules/_zstd/zstddict.c
index 35d6ca8e55a2658e3e4c1ef1ea236af9bf60753c..76e966f5b1b52a486eb6ad66427e6fdc6266dd40 100644 (file)
--- a/Modules/_zstd/zstddict.c
+++ b/Modules/_zstd/zstddict.c
@@ -119,10 +119,10 @@ ZstdDict_dealloc(PyObject *ob)
 }
 
 PyDoc_STRVAR(ZstdDict_dictid_doc,
-"the Zstandard dictionary, an int between 0 and 2**32.\n\n"
-"A non-zero value represents an ordinary Zstandard dictionary, "
+"The Zstandard dictionary, an int between 0 and 2**32.\n\n"
+"A non-zero value represents an ordinary Zstandard dictionary,\n"
 "conforming to the standardised format.\n\n"
-"The special value '0' means a 'raw content' dictionary,"
+"A value of zero indicates a 'raw content' dictionary,\n"
 "without any restrictions on format or content.");
 
 static PyObject *
@@ -210,12 +210,12 @@ compress(dat, zstd_dict=zd.as_prefix)
 1. Prefix is compatible with long distance matching, while dictionary is not.
 2. It only works for the first frame, then the compressor/decompressor will
    return to no prefix state.
-3. When decompressing, must use the same prefix as when compressing."
+3. When decompressing, must use the same prefix as when compressing.
 [clinic start generated code]*/
 
 static PyObject *
 _zstd_ZstdDict_as_prefix_get_impl(ZstdDict *self)
-/*[clinic end generated code: output=6f7130c356595a16 input=d59757b0b5a9551a]*/
+/*[clinic end generated code: output=6f7130c356595a16 input=45b3b6110f36d127]*/
 {
     return Py_BuildValue("Oi", self, DICT_TYPE_PREFIX);
 }