TuringLang / TuringLang/SSMProblems.jl
Naming Convention Consistency
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 11
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
We should make the following naming conventions consistent:
- Particles, states, ref_traj, ref_state
- Algo and filter
- T vs K
- ws and weights (weights)
- States vs xs
- iter and k (iter in doc strings, k in loops)
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
No files, tests, or entry points are identified. Start by locating uses of the listed names across the Julia package and documenting where each convention appears. Done means the naming choices are consistent in code, loops, and docstrings, with affected tests still passing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- developer-experience
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100