Ignore pydocstyle errors D100 and D103 on python unittest files

Đang mở
  • Có gì không ổn?
#10 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
tooling

Hướng nghiên cứu

Xác định cấu hình pydocstyle của repository và kiểm tra cách tên tệp kiểm thử Python được nhận diện. Xác minh rằng D100 và D103 được bỏ qua đối với các tệp unittest dự định mà không bị vô hiệu hóa ở nơi khác; issue không nêu tệp cấu hình hoặc lệnh kiểm thử cụ thể nào.

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

Mô tả

enhancement

Detailed Description

Ignore these two pydocstyle errors on python unittest files:

  • D100: Missing docstring in public module
  • D103: Missing docstring in public function

Context

Unittest functions rarely have module or function docstrings!

Implementation

Is it possible to ignore all python filenames with test in the filename?

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
1
Fork
11
Không có pull request nào được merge trong 30 ngày

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

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có 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 openclimatefix/.github

Tất cả issue của openclimatefix/.github

Issue tương tự

Thêm issue về DevTools

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.