Argument Clinic: add reference for all directives
Abierto
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 good reference for all Argument Clinic directives (@getter, output, etc.). Some of the directives accept one or more parameters; perhaps we can use typical CLI documentation for inspiration (@critical_section [arg1] [arg2]).
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 localizando la documentación existente de Argument Clinic y las definiciones actuales de las directivas. Haz un inventario de todas las directivas, incluidas las que tienen parámetros, y compara su sintaxis con el ejemplo de estilo CLI del issue. El trabajo estará terminado cuando el devguide proporcione una referencia clara que cubra cada directiva y sus parámetros aceptados.
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
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100