astronomy-commons/lsdb

Make internal implementations "protected"

Aperta

#830 aperta il 13 giu 2025

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Python (21 fork)auto 404
enhancementgood first issueinterface

Metriche repository

Star
 (54 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esplora la struttura del pacchetto e identifica quali moduli e classi sono destinati all'uso pubblico. Controlla il init .py di livello superiore per vedere cosa viene reimportato e cerca moduli chiamati 'internal' o 'implementation' che dovrebbero essere resi privati con un prefisso underscore.
Tech stack
python
Dominio
backenddeveloper experience
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75