doc default arguments for Pathfinder
Open
Nobody has claimed this yet.
documentation
feature
- Dominant language
- Python
- Stars
- 198
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Summary:
The arg = None style is used for the method pathfinder, but it would be nice if the doc listed what the default argument was.
Description:
For example, argument num_elbo_draws=None has documentation
num_elbo_draws (Optional[int]) – Number of Monte Carlo draws to evaluate ELBO.
with no indication of what the default value is.
Current Version:
1.20
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 Pathfinder pathfinder method and its generated documentation or docstring, then inspect the num_elbo_draws argument description. Update the documentation to state the default value for this and any equivalent defaulted arguments, and verify the generated documentation reflects the change.
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
- 50/100