Docs style guide: Code Examples, distinguish between the Tutorial and other documentation

Đang mở
#1,627 4 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
documentation

Hướng nghiên cứu

Payload không nêu tên tệp hay bài kiểm thử nào trong repository; trước tiên hãy tìm hướng dẫn về phong cách tài liệu của devguide và hướng dẫn của nó về các ví dụ mã trong Tutorial. Đọc issue BPO được liên kết để hiểu sự phân biệt được dự định, sau đó cập nhật tài liệu liên quan để các ví dụ trong Tutorial được xử lý rõ ràng tách biệt với các tài liệu khác.

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

Mô tả

needs: decision topic-documentation type-feature
BPO 40758
Nosy @rhettinger, @ChasBelov

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 2020-05-24.20:49:25.128>
labels = ['3.8', '3.9', '3.10', 'docs']
title = 'For 7.2.7. Code Examples, distinguish between the Tutorial and other documentation'
updated_at = <Date 2021-03-26.03:23:38.984>
user = 'https://github.com/ChasBelov'

bugs.python.org fields:

activity = <Date 2021-03-26.03:23:38.984>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-05-24.20:49:25.128>
creator = 'Chas Belov'
dependencies = []
files = []
hgrepos = []
issue_num = 40758
keywords = []
message_count = 2.0
messages = ['369825', '389537']
nosy_count = 3.0
nosy_names = ['rhettinger', 'docs@python', 'Chas Belov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40758'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Ngôn ngữ chính
Python
Star
2.1k
Fork
1k
Merge trung bình
2 ngày 12 giờ
Pull request đã merge (30 ngày)
12

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.

Issue khác của python/devguide

Tất cả issue của python/devguide

Issue tương tự

Thêm issue về Python

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.