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.

Sign up for GitHub

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

Jump to bottom

bpo-31394: Clarify documentation about token type attribute #3469

Merged
merged 3 commits into from
Sep 13, 2017
Merged

bpo-31394: Clarify documentation about token type attribute #3469

merged 3 commits into from
Sep 13, 2017

Conversation

aivarannamaa
Copy link
Contributor

@aivarannamaa aivarannamaa commented Sep 9, 2017 •
edited by bedevere-bot
Loading

Make it clear that Ellipsis tokens are among these tokens, which have type attribute set to token.OP.

See https://bugs.python.org/issue31394 for the discussion.

https://bugs.python.org/issue31394

@aivarannamaa
Clarify documentation about tokens' type attribute
80f1514 
Make it clear that Ellipsis tokens also have type attribute set to token.OP.
See https://bugs.python.org/issue31394 for discussion
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

berkerpeksag
berkerpeksag requested changes Sep 9, 2017
View reviewed changes
Doc/library/tokenize.rst Outdated
@@ -17,7 +17,7 @@ as well, making it useful for implementing "pretty-printers," including
colorizers for on-screen displays.

To simplify token stream handling, all :ref:`operators` and :ref:`delimiters`
tokens are returned using the generic :data:`~token.OP` token type. The exact
tokens and Ellipsis are returned using the generic :data:`~token.OP` token type. The exact
Copy link
Member

Choose a reason for hiding this comment

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

Ellipsis -> :data:`Ellipsis`

Copy link
Member

Choose a reason for hiding this comment

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

Still needed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't understand, what is still needed.

Copy link
Member

Choose a reason for hiding this comment

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

Replace Ellipsis with :data:`Ellipsis`.

Doc/library/tokenize.rst Outdated
@@ -17,7 +17,7 @@ as well, making it useful for implementing "pretty-printers," including
colorizers for on-screen displays.

To simplify token stream handling, all :ref:`operators` and :ref:`delimiters`
Copy link
Member

Choose a reason for hiding this comment

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

Could you also address @terryjreedy's comment on the tracker and change

:ref:`operators` and :ref:`delimiters`

to

:ref:`operator <operators>` and :ref:`delimiter <delimiters>`

Copy link
Member

Choose a reason for hiding this comment

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

Fixed

@bedevere-bot
Copy link

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 I didn't expect the Spanish Inquisition!. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@aivarannamaa
Copy link
Contributor Author

I didn't expect the Spanish Inquisition!

@bedevere-bot
Copy link

Nobody expects the Spanish Inquisition!

@berkerpeksag: please review the changes made to this pull request.

@Mariatta Mariatta added the docs Documentation in the Doc dir label Sep 10, 2017
@Mariatta
Copy link
Member

Thanks @terryjreedy and @berkerpeksag for the review. I checked that the changes have been made.

@Mariatta Mariatta merged commit 5f8fbf9 into python:master Sep 13, 2017
@miss-islington
Copy link
Contributor

Thanks @aivarannamaa for the PR, and @Mariatta for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @aivarannamaa and @Mariatta, I could not cleanly backport this to 3.6 due to a conflict.
Please backport using cherry_picker on command line.

@Mariatta
Copy link
Member

Thanks @aivarannamaa and congrats on your first contribution to CPython 🌮

Mariatta pushed a commit to Mariatta/cpython that referenced this pull request Sep 13, 2017
@aivarannamaa @Mariatta
[3.6] bpo-31394: Clarify documentation about token type attribute (py…
58c7fc5 
…thonGH-3469)

Make it clear that Ellipsis tokens also have type attribute set to token.OP..
(cherry picked from commit 5f8fbf9)
@bedevere-bot
Copy link

GH-3525 is a backport of this pull request to the 3.6 branch.

Mariatta added a commit that referenced this pull request Sep 13, 2017
@Mariatta
[3.6] bpo-31394: Clarify documentation about token type attribute (GH…
5513e88 
…-3469) (GH-3525)

Make it clear that Ellipsis tokens also have type attribute set to token.OP..
(cherry picked from commit 5f8fbf9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@berkerpeksag berkerpeksag berkerpeksag requested changes

@terryjreedy terryjreedy terryjreedy left review comments

@Mariatta Mariatta Mariatta approved these changes

Assignees
No one assigned
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.
7 participants
@aivarannamaa @the-knights-who-say-ni @bedevere-bot @Mariatta @miss-islington @berkerpeksag @terryjreedy