Improving Synchronizer documentation

未关闭
#379 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
半天
新手友好度
42/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

The gap is in the API reference for Synchronizer.__init__, linked from the sync.html page under api in the readthedocs site, and the docstring that feeds it. Read how the constructor's action parameter relates to SyncPolicyManager, then add a short usage example that shows the link between them for uploads and downloads. Done when a reader can follow the page to a working Synchronizer setup without outside help.

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

描述

help wanted

The documentation suggest that using the Synchronizer class to handle file operations is better but further reading the docs on how to use the Synchronizer class is just so convoluted.
It was only mentioned vaguely that one could use the Synchronizer to handle uploads and downloads but was not properly explained that you have to use the SyncPolicyManager class to set an action in the Synchronizer constructor params.

主要语言
Python
星标
214
派生
68
平均合并
51 分钟
30 天内合并 PR
6

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

Backblaze/b2-sdk-python 的其他 Issue

查看 Backblaze/b2-sdk-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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