crate / crate/crate-python

Improve the documentation about BLOBs

未关闭
#627 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
85
派生
34
平均合并
3 天 1 小时
30 天内合并 PR
4

描述

### Backlog
- [ ] Rework the documentation about BLOBs. Currently, it is scattered between `docs/blobs.rst`, `docs/by-example/http.rst`, and `docs/by-example/blob.rst`, and apparently outlines different access variants or stages. Let's sort this out.

_Originally posted by @amotl in https://github.com/crate/crate-python/issues/448#issuecomment-1343332778_

贡献指南

打开贡献指南

调研方向

并排阅读 docs/blobs.rst、docs/by-example/http.rst 和 docs/by-example/blob.rst,首先确定每个文档所描述的不同访问变体或阶段。重新整理这三个部分,使其对 BLOB 处理形成一致的说明,不再留下相互冲突的指导。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

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