readthedocs / readthedocs/sphinx-autoapi
A module attribute with a value declared separately from its type is documented twice
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Essentially, we need to address this TODO that's in the tests: https://github.com/readthedocs/sphinx-autoapi/blob/99366617719f8e57d3b1807bc977d3153434750c/tests/python/test_pyintegration.py#L352-L355
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
Start with the TODO in tests/python/test_pyintegration.py around lines 352-355 and run the relevant Python integration test. Trace the documented module attribute case where its value is declared separately from its type; done means the attribute appears only once in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100