-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
gh-132983: Convert zstd __new__ methods to Argument Clinic #133860
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.
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
base: main
Are you sure you want to change the base?
Conversation
is_raw: bool = False | ||
If true, perform no checks on *dict_content*, useful for some | ||
advanced cases. Otherwise, check that the content represents | ||
a Zstandard dictionary created by the zstd functions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a Zstandard dictionary created by the zstd functions. | |
a Zstandard dictionary created by the zstd library or CLI. |
"the zstd functions" sounds a bit awkward here, maybe something like this is a bit better?
"a specified format.\n\n" | ||
"0 means a \"raw content\" dictionary, free of any format restriction, used\n" | ||
"for advanced user."); | ||
"The ID of Zstandard dictionary, an integer between 0 and 2**32.\n\n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The ID of Zstandard dictionary, an integer between 0 and 2**32.\n\n" | |
"The ID of the Zstandard dictionary, an int between 0 and 2**32.\n\n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few suggestions but otherwise looks great!
tp_init
functions intotp_new
and convert the latter to AC. This also means we can remove theinitialised
member from the object structs.ZstdDict
to make the content positional-only andis_raw
kw-only.A
cc @Rogdham