document function `rebuild_cmdstan`; add detection of need to rebuild gch headers; improve error message
Open
Nobody has claimed this yet.
build
documentation
- Dominant language
- Python
- Stars
- 198
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Summary:
When compilation fails because the user needs to rebuild cmdstan, detect this failure and make a better error message.
Add troubleshooting section to the docs, and document function rebuild_cmdstan.
Description:
This is very frustrating for MacOS users, because when Xcode changes, CmdStan needs to be rebuilt.
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 rebuild_cmdstan function and the code that handles CmdStan compilation failures. Review the existing documentation structure for a troubleshooting section. Done means detecting when CmdStan needs rebuilding, producing a clearer error message, and documenting both the troubleshooting steps and rebuild_cmdstan.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- macos, python
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100