lincc-frameworks / lincc-frameworks/hyrax
rst class warnings
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 7
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 8
Description
Failing to comment the entire class hierarchy, or some issue like that, can cause the below warnings which are visible when running `pre-commit`. I tried finding the and fixing the offending comments in `kafka_stream_dataset.py` but didn't know what to do for them. Pretty sure just correcting the hierarchy or finding a way to get around it in the comments should stop these warnings.
```
/astro/users/samnsid7/hyrax/docs/autoapi/hyrax/datasets/kafka_stream_dataset/index.rst:8: WARNING: py:meth reference target not found: __iter__ [ref.meth]
/astro/users/samnsid7/hyrax/docs/autoapi/hyrax/datasets/kafka_stream_dataset/index.rst:15: WARNING: py:meth reference target not found: _decode [ref.meth]
/astro/users/samnsid7/hyrax/docs/autoapi/hyrax/datasets/kafka_stream_dataset/index.rst:43: WARNING: py:meth reference target not found: stop [ref.meth]
```
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.
Research direction
Run pre-commit to reproduce the warnings, then inspect hyrax/datasets/kafka_stream_dataset.py alongside the generated docs/autoapi/hyrax/datasets/kafka_stream_dataset/index.rst. Trace the references for __iter__, _decode, and stop and correct the documented class hierarchy or comments so the warnings no longer appear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100