python / python/devguide

Argument Clinic: add reference for the DSL

Đang mở
#1,270 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

type-feature
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ả

We need a better reference for the Argument Clinic DSL:

  • legal syntax for the "function name" line
  • legal syntax for parameter lines
  • legal syntax for docstrings

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

Bắt đầu bằng cách tìm tài liệu Argument Clinic hiện có và mọi tham chiếu DSL hiện tại trong devguide. So sánh phạm vi được ghi lại trong tài liệu với cú pháp được yêu cầu cho tên hàm, dòng tham số và docstring; công việc hoàn tất khi có một tài liệu tham chiếu giải thích cú pháp hợp lệ cho cả ba lĩnh vực.

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.