gh-99146 struct module documentation should have more predictable examples/warnings #99141
Conversation
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
smontanaro
changed the title
|
Could the PR title (which will become the commit message) be less colloquial and mention that this is about struct doc? |
smontanaro
changed the title
|
@merwok Sorry, updated. |
gpshead
approved these changes
Nov 7, 2022
gpshead
added
needs backport to 3.10
|
I added an Applications section which discusses the different needs of native and machine-independent formats. I also made sure all format strings contain a prefix character. |
gpshead
requested changes
Nov 12, 2022
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
gpshead
reviewed
Nov 12, 2022
gpshead
reviewed
Nov 14, 2022
gpshead
approved these changes
Nov 15, 2022
|
Trust me, @gpshead, I got more out of the process than Python did. Thanks for the help/patience/feeback. Onto my next random module... |
|
@mdickinson or @gpshead Can you merge with you have a moment? Thx... |
mdickinson
reviewed
Nov 22, 2022
|
Looks very good to me. Since @gpshead has approved, I'll merge as soon as the CI completes. |
|
Thanks @smontanaro for the PR, and @mdickinson for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 22, 2022
…le examples/warnings (pythonGH-99141) * nail down a couple examples to have more predictable output * update a number of things, but this is really just a stash... * added an applications section to describe typical uses for native and machine-independent formats * make sure all format strings use a format prefix character * responding to comments from @gpshead. Not likely finished yet. * This got more involved than I expected... * respond to several PR comments * a lot of wordsmithing * try and be more consistent in use of ``x`` vs ``'x'`` * expand examples a bit * update the "see also" to be more up-to-date * original examples relied on import * so present all examples as if * reformat based on @gpshead comment (missed before) * responding to comments * missed this * one more suggested edit * wordsmithing (cherry picked from commit 22d91c1) Co-authored-by: Skip Montanaro <[email protected]>
|
GH-99702 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 22, 2022
…le examples/warnings (pythonGH-99141) * nail down a couple examples to have more predictable output * update a number of things, but this is really just a stash... * added an applications section to describe typical uses for native and machine-independent formats * make sure all format strings use a format prefix character * responding to comments from @gpshead. Not likely finished yet. * This got more involved than I expected... * respond to several PR comments * a lot of wordsmithing * try and be more consistent in use of ``x`` vs ``'x'`` * expand examples a bit * update the "see also" to be more up-to-date * original examples relied on import * so present all examples as if * reformat based on @gpshead comment (missed before) * responding to comments * missed this * one more suggested edit * wordsmithing (cherry picked from commit 22d91c1) Co-authored-by: Skip Montanaro <[email protected]>
|
GH-99703 is a backport of this pull request to the 3.10 branch. |
mdickinson
pushed a commit
that referenced
this pull request
Nov 22, 2022
…ble examples/warnings (GH-99141) (GH-99702) gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) * nail down a couple examples to have more predictable output * update a number of things, but this is really just a stash... * added an applications section to describe typical uses for native and machine-independent formats * make sure all format strings use a format prefix character * responding to comments from @gpshead. Not likely finished yet. * This got more involved than I expected... * respond to several PR comments * a lot of wordsmithing * try and be more consistent in use of ``x`` vs ``'x'`` * expand examples a bit * update the "see also" to be more up-to-date * original examples relied on import * so present all examples as if * reformat based on @gpshead comment (missed before) * responding to comments * missed this * one more suggested edit * wordsmithing (cherry picked from commit 22d91c1) Co-authored-by: Skip Montanaro <[email protected]> Co-authored-by: Skip Montanaro <[email protected]>
mdickinson
pushed a commit
that referenced
this pull request
Nov 22, 2022
…ble examples/warnings (GH-99141) (GH-99703) gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) * nail down a couple examples to have more predictable output * update a number of things, but this is really just a stash... * added an applications section to describe typical uses for native and machine-independent formats * make sure all format strings use a format prefix character * responding to comments from @gpshead. Not likely finished yet. * This got more involved than I expected... * respond to several PR comments * a lot of wordsmithing * try and be more consistent in use of ``x`` vs ``'x'`` * expand examples a bit * update the "see also" to be more up-to-date * original examples relied on import * so present all examples as if * reformat based on @gpshead comment (missed before) * responding to comments * missed this * one more suggested edit * wordsmithing (cherry picked from commit 22d91c1) Co-authored-by: Skip Montanaro <[email protected]> Co-authored-by: Skip Montanaro <[email protected]>
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.
This PR contains three changes: