Skip to content

bpo-30935: update get_event_loop docs #2731

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

Merged
merged 2 commits into from
May 29, 2018
Merged

bpo-30935: update get_event_loop docs #2731

merged 2 commits into from
May 29, 2018

Conversation

daxlab
Copy link
Contributor

@daxlab daxlab commented Jul 16, 2017

@mention-bot
Copy link

@daxlab, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld to be a potential reviewer.

@@ -165,7 +165,7 @@ An event loop policy must implement the following interface:

.. method:: get_event_loop()

Get the event loop for the current context.
Get the event loop for the current coroutine.
Copy link
Member

Choose a reason for hiding this comment

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

You want to say this not in the documentation of the interface, but in the documentation of the default policy.

Also, in the bpo issue I suggested adding a "Changed in 3.6" directive, but I don't see that here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Isn't it already there ?

Copy link
Member

Choose a reason for hiding this comment

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

In "What's New," yes, but not in the asyncio section of the docs.

Copy link
Member

Choose a reason for hiding this comment

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

See the documentation of AbstractEventLoop.run_forever() for an example. In this case, it says, "Changed in version 3.5.1."

@Mariatta Mariatta added needs backport to 3.6 docs Documentation in the Doc dir labels Sep 10, 2017
Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

Please add the "Changed in 3.6" directive as suggested by @cjerdonek

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

add version changed directive
@daxlab
Copy link
Contributor Author

daxlab commented Oct 1, 2017

I didn't expect the Spanish Inquisition!

@bedevere-bot
Copy link

Nobody expects the Spanish Inquisition!

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

Copy link
Member

@cjerdonek cjerdonek left a comment

Choose a reason for hiding this comment

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

This still doesn't update the get_event_loop() docs as I said in the original bpo issue and in my previous review comment.

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

@1st1
Copy link
Member

1st1 commented Oct 19, 2017

Please update the docstring of get_event_loop()

@csabella
Copy link
Contributor

@daxlab There were some additional changes requested since your last commit. Would you be able to take a look at those? Thanks!

@1st1 1st1 reopened this May 29, 2018
@1st1 1st1 merged commit e55de2d into python:master May 29, 2018
@miss-islington
Copy link
Contributor

Thanks @daxlab for the PR, and @1st1 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 29, 2018
(cherry picked from commit e55de2d)

Co-authored-by: Mandeep Singh <[email protected]>
@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 29, 2018
(cherry picked from commit e55de2d)

Co-authored-by: Mandeep Singh <[email protected]>
miss-islington added a commit that referenced this pull request May 29, 2018
(cherry picked from commit e55de2d)

Co-authored-by: Mandeep Singh <[email protected]>
miss-islington added a commit that referenced this pull request May 29, 2018
(cherry picked from commit e55de2d)

Co-authored-by: Mandeep Singh <[email protected]>
@daxlab daxlab deleted the bpo_30935 branch May 31, 2018 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants