Incomplete docstings in `chopper_cascade` module
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 4
- Avg merge
- 6d 13h
- Merged PRs (30d)
- 5
Description
A user was trying to use the output of this module directly instead of the builtin plotting utility. It turned out that was difficult without looking at the code because some fields of the dataclasses lack docstrings and thus do not appear in the API docs. Example:
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 in src/scippneutron/tof/chopper_cascade.py, especially the dataclass fields around lines 63–64, and inspect the surrounding module to identify fields missing docstrings. Document the fields so they appear in the generated API documentation, then verify that the module’s API docs expose the added descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100