Address API documentation summary line TODOs

Abierto
#243 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
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza en el directorio cf/ ejecutando git grep '\"\"\"TODO' | wc -l para localizar los métodos que carecen de docstrings de resumen. Lee cada método afectado, incluido Field.get_coordinate_reference, para entender su propósito básico y su uso. Se considera terminado cuando los docstrings TODO tienen líneas de resumen concisas y se ha abordado la cantidad restante.

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

Descripción

All methods should at least have a summary line to outline their basic purpose or usage. Currently this is not the case leaving the rationale for methods such as Field.get_coordinate_reference (as noted in #239) potentially unclear.

As a crude estimate of the number of methods undocumented minimally, git grep '"""TODO' | wc -l under the cf/ dir gives 99 for the state of the codebase at time of making this comment (with the equivalent for "'''TODO" not required as black enforces double-quote marks for docstrings etc.). So ~100 methods need summarising. That's small enough to tackle for the next release, easily.

Lenguaje dominante
Python
Estrellas
150
Forks
23
Merge medio
1 d 11 h
PR fusionados (30 d)
2

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.

Más de NCAS-CMS/cf-python

Todos los issues de NCAS-CMS/cf-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.