JuliaGeometry/Rotations.jl

Rename internal use functions

Open

#204 opened on Nov 22, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (44 forks)github user discovery
help wanted

Repository metrics

Stars
 (189 stars)
PR merge metrics
 (PR metrics pending)

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.
  • 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.
  • 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)

Contributor guide

Research direction
Locate internal functions like vee and lmult, rename them with underscore prefix (e.g., vee, lmult), update all references, and run tests.
Tech stack
julia
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70