Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add Raises: sections to docstrings

Đang mở Phù hợp với người mới
#366 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
63/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với visitor.py và pulse/visitor.py, và dùng pulse/visitor.py:_check_identifier làm ví dụ đầu tiên, vì hàm này tồn tại để ném lỗi. Với mỗi hàm có ném exception, hãy thêm một mục Raises: vào docstring của nó, nêu rõ kiểu exception và điều kiện, theo đúng phong cách docstring đã dùng trong tệp. Hoàn thành khi mọi hàm trong hai tệp có thể ném lỗi đều có mục này; issue không liệt kê hết các hàm, vì vậy hãy tìm các câu lệnh raise để xác định chúng.

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

Mô tả

Currently, various docstrings (for example, many functions in visitor.py and pulse/visitor.py do not contain a Raises: section in their docstring to inform the user of what errors they may raise and why.

Since some function like pulse/visitor.py:_check_identifier exist solely to raise errors, it would be useful to include this information.

Ngôn ngữ chính
Python
Star
29
Fork
33
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
15

Chuẩn bị môi trường

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 qBraid/pyqasm

Tất cả issue của qBraid/pyqasm

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.