Docstrings for the remaining packages, then turn the rule on

Abierto
#127 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python
Área
testing, tooling

Línea de trabajo

Read CONTRIBUTING.md and inspect the remaining public APIs in config.py, adapters/, importers/, store/, gate/, suites/ and snapshots/ to identify the missing docstrings. Then update the select list in pyproject.toml to enable pydocstyle D1 rules and run the project’s Ruff checks. Done when Ruff enforces public API docstrings in CI.

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

Descripción

documentation good first issue size: S
Context

After the runtime, models, grading and manifest issues, about 35 items remain in config.py, adapters/, importers/, store/, gate/, suites/ and snapshots/.

What to do

Add them, then enable the pydocstyle D1 rules in pyproject.toml so new code keeps docstrings.

Done when

ruff enforces docstrings on public APIs in CI.

Where to look

pyproject.toml ([tool.ruff.lint] select)


New here? Read CONTRIBUTING.md and comment on this issue to say you are taking it.


Generated by Claude Code

Lenguaje dominante
Python
Estrellas
0
Forks
0
Merge medio
2 h 13 min
PR fusionados (30 d)
19

Preparar el entorno

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 patsypppe/meridian

Todos los issues de patsypppe/meridian

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.