aio-libs / aio-libs/sphinxcontrib-asyncio

autodoc + classmethod coroutines do not play well together

Ouverte
#7 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
21
Forks
5
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.