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

autodoc: Asynchronous Generators are marked as non-async functions #9639

Closed
johny-b opened this issue Sep 16, 2021 · 0 comments
Closed

autodoc: Asynchronous Generators are marked as non-async functions #9639

johny-b opened this issue Sep 16, 2021 · 0 comments

Comments

@johny-b
Copy link

@johny-b johny-b commented Sep 16, 2021

Describe the bug

PEP-525 Asynchronous Generators are not marked as async.

class Test:
    async def async_a(self):
        '''ASYNC A'''

    async def async_b(self):
        '''ASYNC B'''
        yield 7

together with

.. autoclass:: ttt.Test
    :members:

Generates:
image

How to Reproduce

All the necessary information is in Describe the bug section.

Expected behavior

I expect every async def to be marked as async.

Your project

I've no sphinx project yet, just testing options

Screenshots

No response

OS

Ubuntu 20.04.2 LTS

Python version

3.8.10

Sphinx version

4.2.0

Sphinx extensions

sphinx.ext.autodoc

Extra tools

No response

Additional context

No response

@johny-b johny-b added the bug label Sep 16, 2021
@tk0miya tk0miya added this to the 4.3.0 milestone Sep 16, 2021
@tk0miya tk0miya added enhancement and removed bug labels Sep 16, 2021
@tk0miya tk0miya closed this in ccfca45 Sep 17, 2021
tk0miya added a commit that referenced this issue Sep 17, 2021
Close #9639: autodoc: Support asynchronous generator functions
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants