JuliaGeometry/Rotations.jl

Rename internal use functions

Open

#204 ouverte le 22 nov. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Julia (44 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (189 stars)
Métriques de merge PR
 (Métriques PR en attente)

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)

Guide contributeur

Direction de recherche
Localisez les fonctions internes comme vee et lmult, renommez les avec un prefixe de soulignement (par exemple, vee, lmult), mettez a jour toutes les references et executez les tests.
Stack technique
julia
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JuliaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70