aio-libs / aio-libs/sphinxcontrib-asyncio

autodoc + classmethod coroutines do not play well together

Abierto
#7 1 comentario 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
21
Forks
5
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.