E-BFMI isn't documented
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 43
- Forks
- 133
- Avg merge
- 11h 32m
- Merged PRs (30d)
- 4
Description
Following up on https://discourse.mc-stan.org/t/issues-with-e-bfmi-missing-doc-confusing-name-etc/22553.
E-BFMI is not documented anywhere (at least using the search functionality in the user's guide and reference manual there were no results for "BFMI"). The only place I found any mention of the E-BFMI diagnostic is in the CmdStan Guide but it only links to a paper, so that's not even really software documentation (although it's better than what we have elsewhere).
Current Version:
v2.26.0
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
Search the User's Guide, Reference Manual, and CmdStan Guide for BFMI to confirm the current coverage and identify the documentation sources to update. Read the linked paper for the diagnostic details, then document E-BFMI in the appropriate user-facing guides and verify that searches for “BFMI” find it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- tex
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100