Add docstring linting (D-class rules) to ruff configuration
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
The Ruff configuration is in pyproject.toml:60; start by reviewing the ignored D class and the existing lint setup. Measure the current D-rule violations, then define the selected rules and per-file exceptions; done means the agreed D rules are enabled without unresolved legacy violations.
Written by the indexing model from the issue text.
Description
Description
The project currently ignores all docstring linting rules (D-class) in the ruff configuration with a TODO comment.
Location
pyproject.toml:60
[tool.ruff.lint]
# The D (doc) and DTZ (datetime zone) lint classes current heavily violated - fix later
select = ["ALL"]
ignore = [
"D", # todo: docstring linting
# ...
]
Impact
- Inconsistent or missing docstrings across the codebase
- Reduced code maintainability and readability
- Harder for new contributors to understand code functionality
Suggested Implementation
- Start by enabling specific D-rules that are least violated (e.g., D100, D101 for missing docstrings)
- Gradually fix existing violations or use per-file ignores for legacy code
- Eventually enable all D-rules for new code
Related
Similar TODO exists for DTZ (datetime zone) rules which should also be addressed.
- Dominant language
- Python
- Stars
- 16
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openml/server-api
-
behavior
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
openml/server-api#337 · 1 comment ·
-
proposal
openml/server-api#375 · 2 comments · 1 assignee ·
-
openml/server-api#374 · 2 comments · 1 assignee ·
-
openml/server-api#373 · 1 assignee ·
-
openml/server-api#372 · 1 assignee ·
All issues in openml/server-api
Similar issues
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
[Feature] 奇物选择添加优先级 Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
syfoud/Simulated_Scepter#174 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Giskard-AI/giskard-oss#2840 · 1 comment ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success Openarea: repo bug perceived difficulty: 2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·