python / python/cpython

dbm.whichdb docstring shows outdated return-value example

Đang mở
#153,305 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.

docs
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ả

dbm.whichdb() returns the dotted submodule name, such as "dbm.ndbm" or
"dbm.gnu" (these are the keys of the internal _modules dispatch table, and
the values documented in Doc/library/dbm.rst).

The function docstring in Lib/dbm/__init__.py still shows the pre-package
form:

- the name of the dbm submodule (e.g. "ndbm" or "gnu") if recognized.

The example should use the actual dotted names, to match the code and the
documentation.

Linked PRs
  • gh-153306

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

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

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.

Hướng nghiên cứu

Mở Lib/dbm/init.py và tìm docstring của dbm.whichdb(). Cập nhật ví dụ về giá trị trả về để sử dụng các tên submodule dạng dấu chấm được mô tả trong issue, sau đó xác minh rằng nó khớp với các giá trị được ghi lại trong Doc/library/dbm.rst.

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ó
1/5
Thời gian dự kiến
Dưới một giờ
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

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.