[mkdocs] No types or annotations for parameters
Abierto
Nadie ha tomado este issue todavía.
bug
P1
- Lenguaje dominante
- Python
- Estrellas
- 18.8k
- Forks
- 2.8k
- Merge medio
- 16 h 26 min
- PR fusionados (30 d)
- 21
Descripción
- Functions who include parameters in their docstring that are not explicitly written out in the function signature encounter a "Parameter '...' does not appear in the function signature" warning.
func(self, *args, **kwargs): all params in docstring raise warnings
- Any parameters who do not have a type annotation (except **kwargs and any parameter in the function signature) raises a "No types or annotations for parameters ['parameter_name']"
engine (deprecated) : strdoes not render correctly on markdown causing missing type annotation errorannotation_*doesn't render correctly, adding "\\" renders "annotation" and adding "\\*" renders "annotation"
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza reproduciendo los casos documentados de *args/**kwargs, engine obsoleto y annotation_* en el flujo de renderizado de la documentación de MkDocs. Sigue cómo se analizan y renderizan los nombres de los parámetros y las anotaciones, y verifica después que los parámetros válidos ya no produzcan advertencias y que sus tipos se muestren correctamente en Markdown.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100