Add runnable code snippets to CTable.where() and sort_by() docstrings
- Lenguaje dominante
- Python
- Estrellas
- 211
- Forks
- 58
- Merge medio
- 1 d 17 h
- PR fusionados (30 d)
- 6
Descripción
The docstrings for CTable.where() and CTable.sort_by() describe the API well but contain no runnable Examples: section. New contributors exploring the API in a REPL or reading rendered API docs get no concrete illustration of the lazy-view behaviour introduced in this release.
Suggested work: Add an Examples section to both docstrings (NumPy docstring format) showing:
- where(): filter with a simple predicate, with columns=, and with a compound condition
- sort_by(): sort a plain table, sort a filtered view (demonstrating that it stays lazy until iterated), and multi-key sort
- Both should include print() calls that make the lazy-vs-eager distinction visible
Guía de contribución
Línea de trabajo
Empieza por los docstrings de CTable.where() y CTable.sort_by() y revisa los ejemplos existentes en formato NumPy del repositorio antes de editar. Añade ejemplos ejecutables para los predicados solicitados, la selección de columnas, el filtrado, la ordenación simple y por múltiples claves, y las vistas lazy, con una salida de print() que muestre cuándo se realiza la evaluación; se considera terminado cuando ambos docstrings muestran ejemplos válidos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- Medio día
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 74/100