Documentation for os.exec* functions omits information about required argument
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ả
Documentation
All of the os.exec* functions (there are 8) require the path to the executable to be the first argument given to the executable, as well as specified in the path or file parameter of the exec method. The documentation of the exec* functions doesn't include any information about this requirement, however it can be found at the start of the Process management section of the documentation. I think it should be moved to the exec* function documentation.
Additionally I personally think that the discussion of the different variants of the function is a bit confusing and would be easier to understand if it was structured differently and a few headings were added.
I have some ideas about how to do this and intend to put together a pull request addressing the issues.
Linked PRs
- gh-125565
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 tài liệu về os.exec* tại phần được liên kết library/os.html#os.execl và so sánh phần này với phần Process management. Xem lại PR gh-125565 được liên kết trước khi bắt đầu; công việc hoàn tất khi đối số đường dẫn đến tệp thực thi bắt buộc được ghi lại cùng với các hàm và phần thảo luận về các biến thể rõ ràng hơn.
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100