aio-libs / aio-libs/sphinxcontrib-asyncio

autodoc + classmethod coroutines do not play well together

Offen
#7 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
21
Forks
5
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Here's my code:
```python
class Test:
@classmethod
def a(cls):
"""yay"""
pass

@classmethod
async def b(cls):
"""yay"""
pass

async def c(self):
"""yay"""
pass

def d(self):
"""yay"""
pass
```

My doc:
```rst
.. autoclass:: module.Test
:members: a, b, c, d
```

Here's the generated rst:
```rst
.. py:class:: Test
:module: procrastinate.aiopg_connector


.. py:classmethod:: Test.a()
:module: procrastinate.aiopg_connector

yay


.. py:comethod:: Test.b()
:module: procrastinate.aiopg_connector

yay


.. py:comethod:: Test.c()
:module: procrastinate.aiopg_connector

yay


.. py:method:: Test.d()
:module: procrastinate.aiopg_connector

yay

```

Here's the output:
![Screenshot from 2020-02-21 14-59-04](https://user-images.githubusercontent.com/1457576/75040315-bbd26700-54ba-11ea-9e57-42770865ec6f.png)

As you can see, b fails to be shown as an async class method.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.