astronomy-commons/lsdb

Make internal implementations "protected"

Aberta

#830 aberto em 13 de jun. de 2025

Ver no GitHub
 (0 comentário) (1 reação) (0 responsável)Python (21 forks)auto 404
enhancementgood first issueinterface

Métricas do repositório

Stars
 (54 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

There is a lot of stuff in the package that is not supposed to be used by end users. However, it bubbles up in many places: IDE autocompletions, HTML docs search results, etc. I propose to systematically rename "internal" and "implementation" modules and classes by prefixing them with an underscore, e.g. lsdb._dask, lsdb._nested, etc. I also to propose to hide "public" stuff which is reimported in the top __init__.py.

Also see #767 for API HTML docs improvements.

Guia do colaborador

Direção de pesquisa
Explore a estrutura do pacote e identifique quais módulos e classes são destinados ao uso público. Inspecione o init .py de nível superior para ver o que é reimportado e procure por módulos chamados 'internal' ou 'implementation' que devem ser tornados privados com um prefixo de sublinhado.
Pilha de tecnologia
python
Domain
backenddeveloper experience
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75