UCL-ARC / UCL-ARC/python-tooling
Enforce a docstring style (or allow users to set)
Open
Nobody has claimed this yet.
documentation
enhancement
p4-low
task
- Dominant language
- Python
- Stars
- 62
- Forks
- 10
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 6
Description
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
Contributor guide
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.
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100