UCL-ARC / UCL-ARC/python-tooling
Enforce a docstring style (or allow users to set)
Đang mở
Chưa có ai nhận issue này.
documentation
enhancement
p4-low
task
- Ngôn ngữ chính
- Python
- Star
- 62
- Fork
- 10
- Merge trung bình
- 7 ngày 6 giờ
- Pull request đã merge (30 ngày)
- 6
Mô tả
We can enforce this with https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings. Let's make an issue for that.
Originally posted by @paddyroddy in https://github.com/UCL-ARC/python-tooling/pull/566#discussion_r2215495808
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Start with the Ruff FAQ section linked in the issue, then inspect how this Python template configures Ruff and docstrings. Clarify whether the template should enforce one style or expose a user setting, and consider the work done when that behavior is consistently configured for generated projects.
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
- tooling
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100