Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Rewrite docstrings to match scikit-learn Style

Abierto
#491 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

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

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.

Descripción

documentation enhancement help wanted

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.

Lenguaje dominante
Python
Estrellas
71
Forks
21
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Más de EducationalTestingService/rsmtool

Todos los issues de EducationalTestingService/rsmtool

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.