FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

bpo-38096: Clean up the "struct sequence" / "named tuple" docs by rhettinger · Pull Request #15895 · python/cpython · GitHub

/ cpython Public

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

Merged
pganssle merged 3 commits into
python:masterfrom
rhettinger:named_tuple_concept
Sep 11, 2019
ConversationCommits (3)ChecksFiles changed
Merged

bpo-38096: Clean up the "struct sequence" / "named tuple" docs#15895
pganssle merged 3 commits into
python:masterfrom
rhettinger:named_tuple_concept

Conversation

rhettinger commented Sep 11, 2019 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

rhettinger added docs Documentation in the Doc dir skip news needs backport to 3.7 labels Sep 11, 2019
rhettinger requested a review from tim-one September 11, 2019 07:15
pganssle self-requested a review September 11, 2019 07:50
pganssle approved these changes Sep 11, 2019
View reviewed changes

pganssle left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM.

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

miss-islington commented Sep 11, 2019

Copy link
Copy Markdown
Contributor

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 commented Sep 11, 2019

Copy link
Copy Markdown
Contributor

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 commented Sep 11, 2019

Copy link
Copy Markdown
Contributor

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 pushed a commit to pganssle/cpython that referenced this pull request Sep 11, 2019
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (pytho…
1e95d51 
…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 commented Sep 11, 2019

Copy link
Copy Markdown

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

bedevere-bot commented Sep 11, 2019

Copy link
Copy Markdown

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

tim-one reviewed Sep 11, 2019
View reviewed changes

tim-one left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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".

Comment thread 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

tim-one Sep 11, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Typo: "as" in "Such as class" should be "a".

rhettinger added a commit that referenced this pull request Sep 12, 2019
Revert "bpo-38096: Clean up the "struct sequence" / "named tuple" docs (
eb494b4 
GH-15895)"

This reverts commit 7117074.
rhettinger pushed a commit that referenced this pull request Sep 12, 2019
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895
2bb6bf0 
) (GH-15961)
rhettinger pushed a commit that referenced this pull request Sep 12, 2019
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (GH-15895
b7a310d 
) (GH-15962)
DinoV pushed a commit to DinoV/cpython that referenced this pull request Sep 12, 2019
bpo-38096: Clean up the "struct sequence" / "named tuple" docs (pytho…
9d1bf3b 
…nGH-15895)

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

* Fix remaining occurrences of "struct sequence"

* Repair a user visible docstring
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

tim-one tim-one left review comments
pganssle pganssle approved these changes

Assignees

pganssle

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL