python / python/devguide

Argument clinic: outdated tutorial

Đang mở
#1,253 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.

topic-dev process type-bug
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

Mô tả

Documentation

The tutorial for Argument Clinic in the devguide contains an outdated section. It still describes the early implementation that used to generate calls to PyArg_ParseTuple*() functions. This is no longer the case.

The affected section starts with "First, ensure both places use the same argument-parsing function." and goes for a few paragraphs until "If any of these items differ in any way, adjust your Argument Clinic function specification and rerun Tools/clinic/clinic.py until they are the same."

Given that the output is now very different, this is quite confusing to read. The section probably needs to be completely rewritten.

CC @AlexWaygood @erlend-aasland

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ở tutorial Argument Clinic được liên kết và xem lại phần bắt đầu bằng “First, ensure both places use the same argument-parsing function.”. So sánh các nhận định trong đó với đầu ra và hành vi hiện tại của Tools/clinic/clinic.py. Tài liệu được hoàn tất khi phần này mô tả chính xác cách triển khai hiện tại và không còn trình bày workflow PyArg_ParseTuple*() đã lỗi thời.

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
Khá rõ ràng
Mức phù hợp với người mới
45/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.