Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭 适合新手
#720 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
75/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
python
领域
documentation, testing

调研方向

查看 src/blosc2/ndarray.py 中 CTable.where() 和 sort_by() 的现有可运行示例以了解格式。需要编辑的文件是 src/blosc2/ndarray.py、src/blosc2/schunk.py 和 src/blosc2/lazyexpr.py。添加示例后，运行 pytest --doctest-modules 以验证它们通过。“完成”意味着所有列出的函数都有一个包含可运行代码的“Examples:”部分，并且 doctest 通过。

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
Python
星标
211
派生
63
平均合并
2 天 1 小时
30 天内合并 PR
9

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

Blosc/python-blosc2 的其他 Issue

查看 Blosc/python-blosc2 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。