[DOC] Runnable docstring examples and doctest coverage for core constructors
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 75/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- python
- Bereich
- documentation, testing
Rechercherichtung
Schauen Sie sich die vorhandenen lauffähigen Beispiele in src/blosc2/ndarray.py für CTable.where() und sort_by() an, um das Format zu verstehen. Die zu bearbeitenden Dateien sind src/blosc2/ndarray.py, src/blosc2/schunk.py und src/blosc2/lazyexpr.py. Nachdem Sie die Beispiele hinzugefügt haben, führen Sie pytest --doctest-modules aus, um zu überprüfen, ob sie bestehen. 'Fertig' bedeutet, dass alle aufgeführten Funktionen einen Abschnitt 'Examples:' mit lauffähigem Code haben und die Doctests bestehen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Python
- Sterne
- 212
- Forks
- 71
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 10
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus Blosc/python-blosc2
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Blosc/python-blosc2#731 ·
Maintainer antworten meist innerhalb von 1 Tag
-
sustain-2026
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Blosc/python-blosc2#717 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation sustain-2026
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 80/100
Blosc/python-blosc2#714 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation sustain-2026
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Blosc/python-blosc2#710 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation sustain-2026
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 70/100
Blosc/python-blosc2#722 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in Blosc/python-blosc2
Ähnliche Issues
-
bug good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
yunaremaia/proto-drift#22 ·
-
bug good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
yunaremaia/memwatch#96 ·
-
bug good first issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 91/100
yunaremaia/ci-gate-watch#34 ·
-
bug good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
yunaremaia/agent-capability-attestation#64 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug good first issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 86/100
yunaremaia/agent-call-graph#43 ·
Maintainer antworten meist innerhalb von 1 Tag