[DOC] Runnable docstring examples and doctest coverage for core constructors
Les mainteneurs répondent en général sous 2 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 75/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- python
- Domaine
- documentation, testing
Piste de recherche
Examinez les exemples exécutables existants dans src/blosc2/ndarray.py pour CTable.where() et sort_by() pour comprendre le format. Les fichiers à modifier sont src/blosc2/ndarray.py, src/blosc2/schunk.py et src/blosc2/lazyexpr.py. Après avoir ajouté les exemples, exécutez pytest --doctest-modules pour vérifier qu'ils passent. 'Terminé' signifie que toutes les fonctions listées ont une section 'Examples:' avec du code exécutable et que les doctests passent.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- 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().
- Demonstrate realistic parameters in each example:
chunks=,blocks=,cparams=, andurlpath=. - Verify that all docstrings pass
pytest --doctest-modules.
- Langage dominant
- Python
- Étoiles
- 211
- Forks
- 63
- Merge moyen
- 2 j 3 h
- PR mergées (30 j)
- 10
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de Blosc/python-blosc2
-
sustain-2026
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Blosc/python-blosc2#717 ·
Les mainteneurs répondent en général sous 2 jours
-
documentation sustain-2026
Difficulté 2/5 1-3 heures Accessibilité débutants 80/100
Blosc/python-blosc2#714 ·
Les mainteneurs répondent en général sous 2 jours
-
Improve the remote array guideOuvertedocumentation sustain-2026
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Blosc/python-blosc2#710 ·
Les mainteneurs répondent en général sous 2 jours
-
documentation sustain-2026
Difficulté 2/5 Une demi-journée Accessibilité débutants 74/100
Blosc/python-blosc2#651 · 5 commentaires ·
Les mainteneurs répondent en général sous 2 jours
-
documentation sustain-2026
Difficulté 3/5 1-2 jours Accessibilité débutants 70/100
Blosc/python-blosc2#722 ·
Les mainteneurs répondent en général sous 2 jours
Toutes les issues de Blosc/python-blosc2
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-2 jours Accessibilité débutants 70/100
-
FingerprintSplitter raises ZeroDivisionError when int(frac_train * len(dataset)) floors to zeroOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 7 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
lmstudio-ai/mlx-engine#376 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
pyiron/bagofholding#166 ·