subprocess module docs contain an inconsistent mix of repeated versionchanged descriptions

Đang mở
#101,715 1 bình luận 1 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
38/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 việc xem lại tài liệu của module subprocess và issue 101283, sau đó so sánh các ghi chú versionchanged và versionadded cho Popen, run(), call(), check_call() và check_output(). Kiểm tra cách cwd, input, text, encoding và errors được ghi lại trong các API này. Hoàn thành khi các ghi chú tuân theo một chiến lược nhất quán, không có các mô tả lặp lại hoặc mâu thuẫn.

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

Mô tả

docs topic-subprocess

Documentation

The subprocess module documentation has an explosion of repeated text in versionchanged or versionadded markers splattered over multiple APIs within the docs.

The reality is that many of these are technically all directly Popen API changes, that the other higher level preferred more user friendly APIs like run() and call() and check_call() and check_output() all make use of internally and forward a majority of their arguments to.

Examples to look for: where are cwd, input, text, encoding, errors argument behavior changes/additions mentioned vs which APIs accept these.

I noticed this when looking over the changes made in https://github.com/python/cpython/issues/101283 where it became apparent to me that we're not internally consistent in how we do this within the doc today. The doc needs some cleanup and a strategy for this.

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

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/cpython

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

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.