JuliaGeometry/Rotations.jl

Rename internal use functions

Open

#204 创建于 2021年11月22日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Julia (44 fork)github user discovery
help wanted

仓库指标

Star
 (189 star)
PR 合并指标
 (PR 指标待抓取)

描述

(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)

贡献者指南