Ruff Docstrings
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 85/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation, tooling
Research direction
Open pyproject.toml and locate the existing Ruff or pre-commit configuration. Add the requested docstring checks using the Google convention, then run the pre-commit Ruff checks to confirm docstring linting is enabled and passes.
Written by the indexing model from the issue text.
Description
Use Ruff for precommit Docstrings check.
In pyproject.toml add D for docstrings:
[tool.ruff.lint]
select = ["D", "DOC"]
[tool.ruff.lint.pydocstyle]
convention = "google"
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 3
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 llnl/mada-tools
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
llnl/mada-tools#54 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
llnl/mada-tools#46 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
llnl/mada-tools#33 ·
-
enhancement
llnl/mada-tools#50 · 1 comment · 1 assignee ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 25/100
llnl/mada-tools#49 ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100