ReactiveBayes / ReactiveBayes/ExponentialFamilyProjection.jl
[MINOR, docs] Docstring/typo drift
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 11
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
[MINOR, docs] Docstring/typo drift
Summary
Small documentation defects:
src/projected_to.jl:137—ProjectionParametersdocstring listsdirection = BoundedNormUpdateRule(static(1.0)(missing closing parenthesis).src/projected_to.jl:19—ProjectedTodocstring formatskwargs = nothingaskwargs = nothinginside a bullet (cosmetic).Makefile:34— help target prints a leftover template placeholder:PLACEHOLDERNAME_CHANGE_MAKEFILE_LINE_22.jl Makefile ${YELLOW}targets${RESET}.src/strategies/closed_form.jl— claims exactness for "the specific target-variational pair" with no caveat about constant-base-measure restriction (see issue-01).
Suggested fix
Fix the typo, remove the placeholder string from the Makefile help, and add a base-measure caveat to the ClosedFormStrategy docstring.
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
Review the listed locations in src/projected_to.jl, Makefile:34, and src/strategies/closed_form.jl; read issue-01 before revising the exactness claim. Correct the docstring typo and formatting, remove the Makefile placeholder, and add the stated constant-base-measure caveat. Done means all four defects in the issue are addressed without changing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100