[CI] Linting of docs

Đang mở
#1,296 6 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/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
ci-cd, documentation, tooling

Hướng nghiên cứu

Review the repository's CI configuration and supported Python versions first, then compare ruff and pydocstyle against the Python 3.6 compatibility constraint and the proposed Python 3.7+ environment. Done means documentation and docstrings are linted in CI without breaking supported environments, addressing the class of issue described in #716.

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

Mô tả

Currently there is no linter for doc and docstrings.

As a follow up, this should really be linted. I would advocate using ruff but theoretically that's blocked on still supporting python 3.6 (#1083).

Should work if working in an environment that's 3.7+ though.

The alternative is to use pydocstyle.

This would prevent issues like #716 from appearing. (which I guess can be closed now?)

Ngôn ngữ chính
Python
Star
361
Fork
296
Không có pull request nào được merge trong 30 ngày

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.

Issue khác của openml/openml-python

Tất cả issue của openml/openml-python

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.