Docu: missing return values for Checker.check_all()
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 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
Bắt đầu bằng cách tìm Checker.check_all() trong tệp mã nguồn Python duy nhất của repository và so sánh hành vi của nó với tài liệu ReadTheDocs. Ghi lại các đối số của method, giá trị trả về và các exception được raise, sau đó kiểm tra xem mã nguồn tương ứng và các mục ReadTheDocs có khớp nhau hay không. Công việc được xem là hoàn tất khi hành vi trả về đã rõ ràng đối với người dùng và tài liệu liên quan đã đầy đủ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The docu on source and on readthedocs is unclear about if and what Checker.check_all() returns.
Of course I can read the source and find the answer. But it would easier for all users if all classes and methods would provide a full documentation in the docstring on all arguments, return values and raised exceptions.
- Ngôn ngữ chính
- Python
- Star
- 5.2k
- Fork
- 760
- Merge trung bình
- 8 giờ 11 phút
- Pull request đã merge (30 ngày)
- 4
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc 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 PyCQA/pycodestyle
-
DOC: E252 is not documentedĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
PyCQA/pycodestyle#1294 · 1 bình luận ·
-
Typing and formattingĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
PyCQA/pycodestyle#1302 · 3 bình luận ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 42/100
PyCQA/pycodestyle#1242 · 2 bình luận ·
-
Spurious E231 for nested format substitutionsCó thể làm lại được Pull request cho issue này đã bị đóng mà không được merge. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
PyCQA/pycodestyle#1241 · 2 bình luận · 4 reaction ·
-
`exclude` is applied to `.`Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
PyCQA/pycodestyle#1217 ·
Tất cả issue của PyCQA/pycodestyle
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
SwiftKickMobile/skai#84 ·
-
Lychee link check failedĐang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 82/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
jxxghp/MoviePilot#7070 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
flop-labs/technocore-chat#997 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
tunneld on Windows: Wi-Fi devices are not discovered because uvicorn runs on a ProactorEventLoopĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
doronz88/pymobiledevice3#2051 ·
Maintainer thường phản hồi trong vòng 1 ngày