documentation: make use of improved guide to HMC warnings
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 198
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Summary:
link to here from docs and maybe diagnose command: https://mc-stan.org/misc/warnings
Description:
Describe the issue as clearly as possible.
Additional Information:
Provide any additional information here.
Current Version:
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 by locating the project documentation and the diagnose command entry point. Review how related external guides are linked, then add a link to https://mc-stan.org/misc/warnings where appropriate. Done means users can reach the improved HMC warnings guide from the documented entry points.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100