AnswerDotAI / AnswerDotAI/nbdev
keyword only '*' does not work with documentation
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 5.3k
- Forks
- 514
- Merge medio
- 2 d 30 min
- PR fusionados (30 d)
- 8
Descripción
# Example
Hello! Using keyword only argument such as:
```python
#| export
def super_func(
keyword_or_non_keyword_arg, # this is a keyword or non-keyword arg
*,
keyword_only_arg # this is a keyword only arg
) -> str: # return string
"super func"
...
```
makes the documentation not working:
```python
show_doc(super_func)
```
```
super_func
super_func (keyword_or_non_keyword_arg, keyword_only_arg)
super func
| | Type | Details | | – | ——– | ———– | | keyword_or_non_keyword_arg | | this is a keyword or non-keyword arg | | keyword_only_arg | | | | Returns | str | return string |
```
the documentation for keyword_only_arg is absent
# Configuration
Python 3.7.16
nbdev 2.3.12
Guía de contribución
Línea de trabajo
Empieza reproduciendo el problema con el ejemplo mostrado de Python 3.7.16 y show_doc(super_func) en nbdev 2.3.12, y muestra cómo se representa el parámetro que solo puede especificarse por nombre en la documentación generada; se considera terminado cuando keyword_only_arg aparece con su documentación y los detalles existentes de los parámetros siguen siendo correctos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter, python
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100