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.

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

Support async method definitions in the py domain #2105

Closed
brettcannon opened this issue Nov 1, 2015 · 2 comments
Closed

Support async method definitions in the py domain #2105

brettcannon opened this issue Nov 1, 2015 · 2 comments
Milestone

Comments

@brettcannon
Copy link
Contributor

Python 3.5 adds async methods. It would be great to has a directive like .. async:: to define a method as asynchronous. Not sure how to render it since def isn't rendered for .. method::, but maybe await can be used to denote the asynchronous method since await is appropriate for the method call?

@Rapptz
Copy link
Contributor

Rapptz commented Nov 3, 2015

Libraries such as aiohttp and I believe even the Python stdlib themselves use something akin to this. I suppose it should be fairly easy to add something like this to the main Sphinx py domain.

The actual Python stdlib has other useful ones for decorators and the such.

@tk0miya
Copy link
Member

tk0miya commented Apr 23, 2019

Done in #6295.
Thanks,

@tk0miya tk0miya closed this as completed Apr 23, 2019
@tk0miya tk0miya added this to the 2.1.0 milestone Apr 23, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants