JuliaGeometry/Rotations.jl

Rename internal use functions

Open

#204 aperta il 22 nov 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Julia (44 fork)github user discovery
help wanted

Metriche repository

Star
 (189 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Individua le funzioni interne come vee e lmult, rinominale con prefisso underscore (ad es. vee, lmult), aggiorna tutti i riferimenti ed esegui i test.
Tech stack
julia
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70