gh-143674: Document F/D complex format characters in struct module#143675
Merged
vstinner merged 2 commits intopython:mainfrom Jan 16, 2026
Merged
gh-143674: Document F/D complex format characters in struct module#143675vstinner merged 2 commits intopython:mainfrom
vstinner merged 2 commits intopython:mainfrom
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.
Member
|
Are you using generative AI for this pr? |
Contributor
Author
Yep I use it for commit message and comment |
skirpichev
reviewed
Jan 11, 2026
Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
This comment was marked as resolved.
This comment was marked as resolved.
skirpichev
approved these changes
Jan 11, 2026
Member
|
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. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jan 16, 2026
…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. |
Member
|
Merged, thank you. |
vstinner
pushed a commit
that referenced
this pull request
Jan 16, 2026
…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>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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