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

[DOC] Runnable docstring examples and doctest coverage for core constructors

Abierto Apto para principiantes
#720 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
75/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
documentation, testing

Línea de trabajo

Mira los ejemplos ejecutables existentes en src/blosc2/ndarray.py para CTable.where() y sort_by() para entender el formato. Los archivos a editar son src/blosc2/ndarray.py, src/blosc2/schunk.py y src/blosc2/lazyexpr.py. Después de agregar los ejemplos, ejecuta pytest --doctest-modules para verificar que pasen. 'Hecho' significa que todas las funciones listadas tienen una sección 'Examples:' con código ejecutable y que los doctests pasan.

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

Descripción

documentation sustain-2026

Following issue #650 (which added runnable examples to CTable.where() and sort_by()), several fundamental array constructors in src/blosc2/ndarray.py (empty, zeros, full, fromiter, asarray, linspace) and core SChunk methods in src/blosc2/schunk.py (append_data, get_chunk, decompress_chunk) lack runnable, copy-pasteable Examples: sections in their docstrings.

Furthermore, pytest.ini currently tests doctests only on core.py, ndarray.py, and schunk.py.

Suggested Work
  1. Add NumPy-style runnable docstrings with code and expected output to:
    • src/blosc2/ndarray.py: empty(), zeros(), full(), fromiter(), asarray(), linspace().
    • src/blosc2/schunk.py: append_data(), get_chunk(), decompress_chunk().
    • src/blosc2/lazyexpr.py: compute(), save().
  2. Demonstrate realistic parameters in each example: chunks=, blocks=, cparams=, and urlpath=.
  3. Verify that all docstrings pass pytest --doctest-modules.
Lenguaje dominante
Python
Estrellas
211
Forks
63
Merge medio
1 d 9 min
PR fusionados (30 d)
7

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 Blosc/python-blosc2

Todos los issues de Blosc/python-blosc2

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.