Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename internal use functions #204

Open
hyrodium opened this issue Nov 22, 2021 · 0 comments
Open

Rename internal use functions #204

hyrodium opened this issue Nov 22, 2021 · 0 comments

Comments

@hyrodium
Copy link
Collaborator

hyrodium commented Nov 22, 2021

(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)
@hyrodium hyrodium changed the title Rename internal use funcitons Rename internal use functions Nov 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant