Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta Adatta ai principianti
#720 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
75/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation, testing

Direzione di ricerca

Guarda gli esempi eseguibili esistenti in src/blosc2/ndarray.py per CTable.where() e sort_by() per capire il formato. I file da modificare sono src/blosc2/ndarray.py, src/blosc2/schunk.py e src/blosc2/lazyexpr.py. Dopo aver aggiunto gli esempi, esegui pytest --doctest-modules per verificare che passino. 'Fatto' significa che tutte le funzioni elencate hanno una sezione 'Examples:' con codice eseguibile e che i doctest passano.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Python
Stelle
211
Fork
63
Merge medio
1g 9m
PR unite (30g)
7

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Blosc/python-blosc2

Tutte le issue di Blosc/python-blosc2

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.