Improving Synchronizer documentation

Đang mở
#379 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
42/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
214
Fork
68
Merge trung bình
51 phút
Pull request đã merge (30 ngày)
6

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Backblaze/b2-sdk-python

Tất cả issue của Backblaze/b2-sdk-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.