Everything documented in the API reference should have docstrings

Abierto
#525 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

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

Línea de trabajo

Comienza con la referencia de API en http://distarray.readthedocs.org/en/latest/distarray.html e identifica las funciones, clases, módulos y paquetes documentados que carecen de docstrings. Inspecciona las definiciones correspondientes en el código fuente y añade la documentación que falta; la tarea estará terminada cuando cada elemento incluido en la referencia tenga un docstring.

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

Descripción

docs easy

http://distarray.readthedocs.org/en/latest/distarray.html

If it's in this reference, it should have a docstring, including functions, classes, modules, and packages.

We're not doing too badly on this, but there are some exceptions.

Lenguaje dominante
Python
Estrellas
5
Forks
1
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 enthought/distarray

Todos los issues de enthought/distarray

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.