EducationalTestingService / EducationalTestingService/rsmtool
Rewrite docstrings to match scikit-learn Style
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 71
- Forks
- 21
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
We should try and match the way that scikit-learn writes their docstrings. Here is an example.
For example, there is a blank line between the parameters and the default values are indicated right after the parameter type. It's also nice how the types that are numpy arrays also include the shapes.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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
No se mencionan archivos ni pruebas. Empieza por localizar los docstrings de Python del proyecto y compararlos con el ejemplo enlazado de scikit-learn, incluidos los espacios de los parámetros, los valores predeterminados y las formas de los arrays de NumPy; se considera terminado cuando los docstrings relevantes siguen ese estilo de forma coherente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python, scikit-learn
- Á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
- 28/100