JuliaGeometry/Rotations.jl

Rename internal use functions

Open

#204 aberto em 22 de nov. de 2021

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (44 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (189 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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)

Guia do colaborador

Direção de pesquisa
Localize funcoes internas como vee e lmult, renomeie as com prefixo de sublinhado (por exemplo, vee, lmult), atualize todas as referencias e execute os testes.
Pilha de tecnologia
julia
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70