-
-
Notifications
You must be signed in to change notification settings - Fork 33.9k
gh-143674: Document F/D complex format characters in struct module #143675
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
gh-143674: Document F/D complex format characters in struct module #143675
Conversation
Add documentation for the F (complex from two floats) and D (complex from two doubles) format characters in the struct module docstring. These format characters were implemented but not documented.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
|
Are you using generative AI for this pr? |
Yep I use it for commit message and comment |
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
This comment was marked as resolved.
This comment was marked as resolved.
|
Reported @quanghuynh10111-lab to GitHub. |
|
Thanks @moneebullah25 for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
…ule (pythonGH-143675) Add documentation for the F (complex from two floats) and D (complex from two doubles) format characters in the struct module docstring. These format characters were implemented but not documented. (cherry picked from commit 3e93225) Co-authored-by: Muneeb Ullah <moneebullah25@gmail.com> Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
|
GH-143918 is a backport of this pull request to the 3.14 branch. |
|
Merged, thank you. |
…dule (GH-143675) (#143918) gh-143674: Document F/D complex format characters in struct module (GH-143675) Add documentation for the F (complex from two floats) and D (complex from two doubles) format characters in the struct module docstring. These format characters were implemented but not documented. (cherry picked from commit 3e93225) Co-authored-by: Muneeb Ullah <moneebullah25@gmail.com> Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
|
Fixes #143674
Changes
F(complex from two floats) andD(complex from two doubles) format characters to the struct module docstringRationale
These format characters are implemented in the struct module (lines 858-859, 1189-1190, 1504-1505 in Modules/_struct.c) but were missing from the module's docstring documentation. Users consulting the docstring with
help(struct)would not know these options exist.Testing
Checklist