Add docstrings to all public methods

Đang mở

#207 mở ngày 15/5/2018 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó: 4/5
Thời gian dự kiến: 3-5 ngày
Mức phù hợp với người mới: 35/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: api, documentation

Hướng nghiên cứu

Bắt đầu với get_display_name trong api.MatrixHttpApi, sau đó lập danh mục các phương thức công khai khác của SDK và kiểm tra các bên gọi hiện có của chúng. Hoàn thành nghĩa là mọi phương thức công khai đều có docstring; các phương thức được xem là riêng tư ủy quyền thông qua các wrapper công khai đã lỗi thời kèm cảnh báo, và các lệnh gọi nội bộ SDK sử dụng tên riêng tư.

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

Mô tả

Api layer Client layer documentation good first issue

For instance, get_display_name in api.MatrixHttpApi needs a docstring. Many others as well.

In doing this, you may run across methods that it seems should be private rather than public; in that case, please go ahead and make method call _method while raising a deprecation warning and point all code within the sdk towards _method

Ngôn ngữ chính: Python
Star: 266
Fork: 118
Chỉ số merge pull request: Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
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.
Fork repository và làm thay đổi trên một nhánh.
Mở pull request có tham chiếu số hiệu của issue.

Issue khác của matrix-org/matrix-python-sdk

Archive this repository Đang mở

Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 25/100

matrix-org/matrix-python-sdk#330 · 3 reaction · Mở ngày 3/3/2023
Message Delete Method Đang mở

Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100

matrix-org/matrix-python-sdk#326 · Mở ngày 18/9/2022
Add canonicaljson to runtime dependencies Đang mở

Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 55/100

matrix-org/matrix-python-sdk#324 · Mở ngày 19/4/2022
Registration fails "An access token should not be provided on requests to /register" Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 48/100

matrix-org/matrix-python-sdk#323 · Mở ngày 11/9/2021
Add example for writing an appservice Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100

matrix-org/matrix-python-sdk#319 · Mở ngày 22/2/2021

Tất cả issue của matrix-org/matrix-python-sdk

Issue tương tự

PATCH /interviews/{id} 的 goal 字段没有任何长度上限，500KB 字符串直接落库且每次 GET detail 都全量带回 Đang mở

bug

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100

xinnan-tech/xiaozhi-fde-talk#263 · Mở ngày 24/9/2026
rules: REQ-0480 'left fold' jargon is redundant with its own plain restatement Đang mở

rules

Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100

elong0527/yamaa#978 · Mở ngày 24/9/2026
Validation discards output from runners that report on stderr (jest, unittest) Đang mở

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100

huggingface/Repo2RLEnv#163 · 1 bình luận · Mở ngày 24/9/2026
Source link in quantize_embeddings have shifted code highlights Đang mở

Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100

huggingface/sentence-transformers#4074 · Mở ngày 24/9/2026
Queue insertion button ("插入排队消息") missing in api_server sessions — canInsert allowlist only covers cli/global_agent Đang mở

comp/dashboard invalid P3

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100

NousResearch/hermes-agent#121143 · Mở ngày 24/9/2026

Thêm issue về Python