Intra-package References Documentation Incomplete

Mô tả

BPO	35927
Nosy	@brettcannon, @terryjreedy, @ncoghlan, @ericsnowcurrently
Files	sound.zip: zip of code sample copied from documentation

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2019-02-07.04:38:30.393>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = 'Intra-package References Documentation Incomplete'
updated_at = <Date 2019-02-14.00:38:19.737>
user = 'https://bugs.python.org/ADataGman'

bugs.python.org fields:

activity = <Date 2019-02-14.00:38:19.737>
actor = 'ADataGman'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-02-07.04:38:30.393>
creator = 'ADataGman'
dependencies = []
files = ['48109']
hgrepos = []
issue_num = 35927
keywords = []
message_count = 7.0
messages = ['335002', '335104', '335105', '335126', '335303', '335385', '335486']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'terry.reedy', 'ncoghlan', 'docs@python', 'eric.snow', 'ADataGman']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35927'
versions = ['Python 3.7', 'Python 3.8']

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 bằng cách đọc issue BPO 35927 được liên kết và kiểm tra sound.zip, đoạn mã mẫu được sao chép từ tài liệu. Xác định những tham chiếu trong gói nào còn thiếu hoặc chưa đầy đủ trong tài liệu Python liên quan. Công việc được xem là hoàn tất khi tài liệu bao phủ đầy đủ các tham chiếu được minh họa trong đoạn mã mẫu và các bước kiểm tra tài liệu phù hợp đều đạt.

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ần làm rõ

Mức phù hợp với người mới

35/100

Mô tả

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

Bắt đầu từ đâu

Hướng nghiên cứu

Đánh giá

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