Skip to content

Fix documentation of TrioEventLoop.run_async() #438

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 1 commit into from
Feb 14, 2021

Conversation

ntamas
Copy link
Contributor

@ntamas ntamas commented Nov 2, 2020

Checklist
  • I've ensured that similar functionality has not already been implemented
  • I've ensured that similar functionality has not earlier been proposed and declined
  • I've branched off the master or python-dual-support branch
  • I've merged fresh upstream into my branch recently
  • I've ran tox successfully in local environment
  • I've included docstrings and/or documentation and/or examples for my code (if this is a new feature)
Description:

This PR fixes the documentation of TrioEventLoop.run_async(), which incorrectly suggests that the constructor of TrioEventLoop() has a nursery argument (which it doesn't have).

The new snippet in the docstring now accurately reflects how TrioEventLoop should be used in an existing Trio event loop; copied straight from one of my projects.

@ntamas ntamas force-pushed the fix/doc-fix-TrioEventLoop-run-async branch from cac8ec1 to 59b2942 Compare November 2, 2020 14:53
@coveralls
Copy link

coveralls commented Nov 2, 2020

Coverage Status

Coverage remained the same at 77.868% when pulling 59b2942 on collmot:fix/doc-fix-TrioEventLoop-run-async into 4c739b6 on urwid:master.

@sarnold sarnold mentioned this pull request Feb 11, 2021
6 tasks
@tonycpsu
Copy link
Collaborator

LGTM, thanks.

@tonycpsu tonycpsu merged commit 9626fb4 into urwid:master Feb 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants