curses: initscr(), newterm(), start_color() and the screen type have no docstrings
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 35.9k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Bug report
curses.initscr(), curses.newterm() and curses.start_color() are Python wrappers of the C functions (they copy the ACS_*, LINES/COLS and COLORS/COLOR_PAIRS constants into the package), and the wrappers have no docstring, so help(curses.initscr) shows nothing although _curses.initscr is documented. The curses.screen type has no docstring either, unlike window, complexchar and complexstr.
Also, the docstring of _curses.initscr() says "Return a WindowObject", the name of the C struct rather than the Python type.
Linked PRs
- gh-157547
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.
Hướng nghiên cứu
Bắt đầu với các entry point curses.initscr(), curses.newterm(), curses.start_color() và curses.screen, so sánh đầu ra trợ giúp của chúng với các kiểu _curses.initscr(), window, complexchar và complexstr đã được ghi trong tài liệu. Công việc được xem là hoàn tất khi các wrapper và kiểu screen có docstring hữu ích, đồng thời _curses.initscr() chỉ ra đúng kiểu Python; hãy kiểm tra phần công việc được liên kết gh-157547 trước khi bắt đầu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 25/100