Skip to content

gh-132983: Fix docstrings in ZstdDict #137321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 3, 2025
Merged

gh-132983: Fix docstrings in ZstdDict #137321

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
46855aa
ZstdDict: fix docstrings
Rogdham Aug 2, 2025
1739ffa
Run make regen-all
Rogdham Aug 2, 2025
8447b65
Revert "Run make regen-all" and run clinic instead
Rogdham Aug 2, 2025
ebca5a9
Revert changes in __init_.py
Rogdham Aug 2, 2025
5d6a4ad
Apply Adam Turner suggestions
Rogdham Aug 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Modules/_zstd/clinic/zstddict.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Modules/_zstd/zstddict.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ 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, "
"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,"
"The special value '0' means a 'raw content' dictionary,\n"
"without any restrictions on format or content.");

static PyObject *
Expand Down Expand Up @@ -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);
}
Expand Down
Loading