Skip to content
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

Conversation

@rhettinger
Copy link
Contributor

commented Sep 11, 2019

@pganssle
Copy link
Member

left a comment

LGTM.

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

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.

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.
🐍🍒🤖

@miss-islington

This comment has been minimized.

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

This comment has been minimized.

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
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)
@bedevere-bot

This comment has been minimized.

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.

Copy link

commented Sep 11, 2019

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

@tim-one
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".

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.

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 added a commit that referenced this pull request Sep 12, 2019
rhettinger added a commit that referenced this pull request Sep 12, 2019
vrpolakatcisco added a commit to vrpolakatcisco/cpython that referenced this pull request Sep 12, 2019
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
DinoV added a commit to DinoV/cpython that referenced this pull request Sep 12, 2019
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.