python / python/devguide

Argument Clinic: add reference for the DSL

Abierto
#1,270 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

type-feature
Lenguaje dominante
Python
Estrellas
2.1k
Forks
1k
Merge medio
2 d 12 h
PR fusionados (30 d)
12

Descripción

We need a better reference for the Argument Clinic DSL:

  • legal syntax for the "function name" line
  • legal syntax for parameter lines
  • legal syntax for docstrings

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando la documentación existente de Argument Clinic y cualquier referencia actual al DSL en el devguide. Compara la cobertura documentada con la sintaxis solicitada para nombres de funciones, líneas de parámetros y docstrings; el trabajo estará terminado cuando una referencia explique la sintaxis válida para las tres áreas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.