Skip to content

gh-148529: Minor improvements of the struct module documentation#148565

Merged
serhiy-storchaka merged 1 commit intopython:mainfrom
serhiy-storchaka:docs-struct
Apr 27, 2026
Merged

gh-148529: Minor improvements of the struct module documentation#148565
serhiy-storchaka merged 1 commit intopython:mainfrom
serhiy-storchaka:docs-struct

Conversation

@serhiy-storchaka
Copy link
Copy Markdown
Member

@serhiy-storchaka serhiy-storchaka commented Apr 14, 2026 •
edited by github-actions Bot
Loading

  • Document that 's' and 'p' accept bytes and bytearray.
  • Fix some footnotes.
  • Clarify that "string" is a byte string.
  • Fix the module docstring.

📚 Documentation preview 📚: https://cpython-previews--148565.org.readthedocs.build/

@serhiy-storchaka
pythongh-148529: Minor improvements of the struct module documentation
1a9fff1 
* Document that 's' and 'p' accept bytes and bytearray.
* Fix some footnotes.
* Clarify that "string" is a byte string.
* Fix the module docstring.
@serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Apr 14, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Apr 14, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Apr 14, 2026
Open
@serhiy-storchaka serhiy-storchaka merged commit 3e5a3cb into python:main Apr 27, 2026
65 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Apr 27, 2026
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Apr 27, 2026

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka deleted the docs-struct branch April 27, 2026 18:30
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Apr 27, 2026

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 3e5a3cb2bd222f97f793b01bc1c0f7bb62aefc31 3.13

@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Apr 27, 2026

GH-149063 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Apr 27, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Apr 27, 2026

GH-149072 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Apr 27, 2026
serhiy-storchaka added a commit that referenced this pull request Apr 27, 2026
@miss-islington @serhiy-storchaka
[3.14] gh-148529: Minor improvements of the struct module documentati…
22d53a9 
…on (GH-148565) (GH-149063)

* Document that 's' and 'p' accept bytes and bytearray.
* Fix some footnotes.
* Clarify that "string" is a byte string.
* Fix the module docstring.
(cherry picked from commit 3e5a3cb)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit that referenced this pull request Apr 27, 2026
@serhiy-storchaka
[3.13] gh-148529: Minor improvements of the struct module documentati…
0fd4fd4 
…on (GH-148565) (GH-149072)

* Document that 's' and 'p' accept bytes and bytearray.
* Fix some footnotes.
* Clarify that "string" is a byte string.
* Fix the module docstring.
(cherry picked from commit 3e5a3cb)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vstinner vstinner Awaiting requested review from vstinner

Assignees

@serhiy-storchaka serhiy-storchaka

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@serhiy-storchaka