DOCS: constants are not documented in API/narrative docs
Open
bug
documentation
- Dominant language
- Python
- Stars
- 88
- Forks
- 64
- Avg merge
- 38m
- Merged PRs (30d)
- 1
Description
e.g. `POLARIZATION_STATES` or `CALIBRATION_LEVELS` are not documented, yet referred to in API docs:
https://pyvo.readthedocs.io/en/latest/api/pyvo.dal.imagesearch2.html#pyvo.dal.imagesearch2
It would be nice to have those link work to docs them.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the pyvo.dal.imagesearch2 API documentation page linked in the issue and trace the references to POLARIZATION_STATES and CALIBRATION_LEVELS. Done means each referenced constant has a working documentation link and its documentation is discoverable from the API narrative.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100