Skip to content

/cpython

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

bpo-38096: Clean up the "struct sequence" / "named tuple" docs #15895

Merged
merged 3 commits into from Sep 11, 2019
+40 −37

Conversation

@rhettinger
Copy link
Contributor

commented Sep 11, 2019 •
edited by bedevere-bot

https://bugs.python.org/issue38096
@rhettinger
bpo-38096: Clean up the "struct sequence" / "named tuple" docs
Loading status checks…
6911deb

@rhettinger rhettinger added type-documentation skip news needs backport to 3.7 needs backport to 3.8 labels Sep 11, 2019

@rhettinger rhettinger requested a review from tim-one Sep 11, 2019

@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Sep 11, 2019

@bedevere-bot bedevere-bot added the awaiting core review label Sep 11, 2019

@pganssle pganssle self-requested a review Sep 11, 2019

rhettinger added 2 commits Sep 11, 2019
@rhettinger
Fix remaining occurrences of "struct sequence"
Loading status checks…
39065c0
@rhettinger
Repair a user visible docstring
Loading status checks…
332b5cd
@pganssle
pganssle approved these changes Sep 11, 2019
View changes
Copy link
Member

left a comment

LGTM.

@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Sep 11, 2019

@pganssle pganssle merged commit 7117074 into python:master Sep 11, 2019
5 checks passed

5 checks passed

Azure Pipelines PR #20190911.21 succeeded
Details
bedevere/issue-number Issue number 38096 found
Details
bedevere/news "skip news" label found
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@miss-islington

This comment has been minimized.

Sign in to view
Copy link

commented Sep 11, 2019

Thanks @rhettinger for the PR, and @pganssle for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@bedevere-bot bedevere-bot removed the awaiting merge label Sep 11, 2019

@miss-islington

This comment has been minimized.

Sign in to view
Copy link

commented Sep 11, 2019

Sorry, @rhettinger and @pganssle, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 7117074410118086938044c7a4ef6846ec1662b2 3.8

@miss-islington miss-islington assigned pganssle Sep 11, 2019

@miss-islington

This comment has been minimized.

Sign in to view
Copy link

commented Sep 11, 2019

Sorry @rhettinger and @pganssle, I had trouble checking out the 3.7 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 7117074410118086938044c7a4ef6846ec1662b2 3.7
pganssle added a commit to pganssle/cpython that referenced this pull request Sep 11, 2019
@rhettinger @pganssle
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (pytho… 
…nGH-15895)

* bpo-38096: Clean up the "struct sequence" / "named tuple" docs

* Fix remaining occurrences of "struct sequence"

* Repair a user visible docstring

(cherry picked from commit 7117074)
1e95d51

@bedevere-bot bedevere-bot removed the needs backport to 3.8 label Sep 11, 2019

@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

commented Sep 11, 2019

GH-15961 is a backport of this pull request to the 3.8 branch.
@bedevere-bot

This comment has been minimized.

Sign in to view
Copy link

commented Sep 11, 2019

GH-15962 is a backport of this pull request to the 3.7 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.7 label Sep 11, 2019

@tim-one
tim-one reviewed Sep 11, 2019
View changes
Copy link
Member

left a comment

Looks great! Thank you. Some comments:

  • Left a comment pointing out a typo.

  • Would have liked to see a blurb added to structseq.c pointing out that structseq is an internal CPython implementation detail, and that docs for modules using structseqs should call them "named tuples".
Doc/glossary.rst
Some named tuples are built-in types (such as the above examples).
Alternatively, a named tuple can be created from a regular class
definition that inherits from :class:`tuple` and that defines named
fields. Such as class can be written by hand or it can be created with

This comment has been minimized.

Sign in to view
Copy link
@tim-one

tim-one Sep 11, 2019

Member

Typo: "as" in "Such as class" should be "a".
rhettinger added a commit that referenced this pull request Sep 12, 2019
@rhettinger
Revert "bpo-38096: Clean up the "struct sequence" / "named tuple" docs ( 
GH-15895)"

This reverts commit 7117074.
eb494b4
rhettinger added a commit that referenced this pull request Sep 12, 2019
@pganssle @rhettinger
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895 
) (GH-15961)
Loading status checks…
2bb6bf0
rhettinger added a commit that referenced this pull request Sep 12, 2019
@pganssle @rhettinger
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895 
) (GH-15962)
Loading status checks…
b7a310d
vrpolakatcisco added a commit to vrpolakatcisco/cpython that referenced this pull request Sep 12, 2019
@rhettinger @vrpolakatcisco
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (pytho… 
…nGH-15895)

* bpo-38096: Clean up the "struct sequence" / "named tuple" docs

* Fix remaining occurrences of "struct sequence"

* Repair a user visible docstring
f45af53
DinoV added a commit to DinoV/cpython that referenced this pull request Sep 12, 2019
@rhettinger @DinoV
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (pytho… 
…nGH-15895)

* bpo-38096: Clean up the "struct sequence" / "named tuple" docs

* Fix remaining occurrences of "struct sequence"

* Repair a user visible docstring
9d1bf3b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tim-one tim-one

@pganssle pganssle

Assignees

@pganssle pganssle

Labels
CLA signed skip news type-documentation
Projects
None yet
Milestone
No milestone
6 participants
@rhettinger @miss-islington @bedevere-bot @pganssle @tim-one @the-knights-who-say-ni
You can’t perform that action at this time.