RadioAstronomySoftwareGroup / RadioAstronomySoftwareGroup/pyuvdata
Generate docstrings programmatically to reduce all the duplication
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 102
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 14
Description
We should define docstrings that get repeated in one place and programmatically add them to all the appropriate methods/functions. This will reduce the maintenance burden of keeping them all in sync and render just as nicely for users. Developers working on the code may have to look at the compiled docs to understand things, but we agreed that was worth the reduced maintenance burden.
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
The issue names no files, tests, or entry points. Start by locating the repeated docstrings and the compiled documentation generation path; done means shared programmatic definitions produce equivalent rendered documentation without duplicated maintenance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100