JuliaGeometry / JuliaGeometry/Rotations.jl
Rename internal use functions
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- Julia
- Stars
- 188
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
(originally posted on this comment)
I think we need to distinguish among exported method, non-exported method and internal use method.
- exported method
- e.g.
RotXYZ,nearest_rotation - These methods should be maintained and documented.
- e.g.
- non-exported method
- e.g.
Rotations.params,Rotations.jacobian - These methods also should be maintained and documented.
- The reason for non-exported is just avoiding name conflict.
- e.g.
- internal use method
- e.g.
_pure_quaternion - These functions are regarded as an internal method, and may be changed without breaking release.
- In
Rotations.jl, many functions should be renamed with underscore_. (e.g.vee->_vee,lmult->_lmult)- I'm not sure if such renamings would be a breaking change.
- See blue guide for more information.
- e.g.
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
Start by reviewing the internal-use functions mentioned in src/util.jl and src/unitquaternion.jl, including vee and lmult, then compare their naming with the linked Blue Style guidance. Determine the complete rename scope and whether compatibility concerns apply; done means the intended internal methods are consistently renamed and the relevant package checks pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100