Fix domain specification docstrings of ordered distributions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9.8k
- Forks
- 2.3k
- Avg merge
- 21h 39m
- Merged PRs (30d)
- 5
Description
Comment from https://github.com/pymc-devs/pymc/pull/7457#issuecomment-2317733942
This shouldn't be in discrete.rst but in the docs of the OrderedLogistic/Probit functions.
Also as @AllenDowney mentioned the description of the distributions are themselves wrong: https://github.com/pymc-devs/pymc/blob/d31301279776888c1540bfba890cba38ea250637/pymc/distributions/discrete.py#L1192
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 with pymc/distributions/discrete.py around line 1192 and inspect the OrderedLogistic and OrderedProbit function docstrings, then compare the related content in discrete.rst. Move the domain specification to the appropriate function documentation and correct the distribution descriptions. Done means the docstrings and rendered documentation accurately describe the ordered distributions without the misplaced content in discrete.rst.
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
- 42/100