doc for `fixed_param` should mention it's not necessary
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Review the CmdStanPy documentation for fixed_param and compare its wording with the linked tutorial issue and response. Update the documentation so users understand that CmdStanPy determines whether fixed_param = True is needed based on the model's parameter count, then verify that the revised explanation no longer implies it is always required.
Written by the indexing model from the issue text.
Description
CmdStanPy automatically resolves whether it needs fixed_param = True or not depending on the number of parameters in the model. This isn't clear in the documentation, which makes it sound like this is required. This caused someone to open an issue against my tutorial because they read the CmdStanPy doc:
https://github.com/bob-carpenter/stan-getting-started/issues/6
My response there shows that you don't need fixed_param = True.
- Dominant language
- Python
- Stars
- 198
- Forks
- 81
- Avg merge
- 6d 5h
- Merged PRs (30d)
- 1
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.
More from stan-dev/cmdstanpy
-
Release 2.0 Open
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
feature
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
-
feature method outputs
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
All issues in stan-dev/cmdstanpy
Similar issues
-
agent-ready documentation needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Open
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
instance instance add
Difficulty 1/5 Under an hour Newbie friendliness 72/100
searxng/searx-instances#939 · 1 comment ·
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100