-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
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
Conversation
@daxlab, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld to be a potential reviewer. |
Doc/library/asyncio-eventloops.rst
Outdated
@@ -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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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."
There was a problem hiding this 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
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 |
add version changed directive
I didn't expect the Spanish Inquisition! |
Nobody expects the Spanish Inquisition! @Mariatta: please review the changes made to this pull request. |
There was a problem hiding this 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.
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 |
Please update the docstring of |
@daxlab There were some additional changes requested since your last commit. Would you be able to take a look at those? Thanks! |
GH-7213 is a backport of this pull request to the 3.7 branch. |
(cherry picked from commit e55de2d) Co-authored-by: Mandeep Singh <[email protected]>
GH-7214 is a backport of this pull request to the 3.6 branch. |
(cherry picked from commit e55de2d) Co-authored-by: Mandeep Singh <[email protected]>
(cherry picked from commit e55de2d) Co-authored-by: Mandeep Singh <[email protected]>
(cherry picked from commit e55de2d) Co-authored-by: Mandeep Singh <[email protected]>
https://bugs.python.org/issue30935