astronomy-commons/lsdb

Make internal implementations "protected"

Ouverte

#830 ouverte le 13 juin 2025

Voir sur GitHub
 (0 commentaire) (1 réaction) (0 personne assignée)Python (21 forks)auto 404
enhancementgood first issueinterface

Métriques du dépôt

Stars
 (54 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Explorez la structure du paquet et identifiez les modules et classes destinés à un usage public. Inspectez le init .py de niveau supérieur pour voir ce qui est réimporté et recherchez les modules nommés 'internal' ou 'implementation' qui devraient être rendus privés avec un préfixe underscore.
Stack technique
python
Domaine
backenddeveloper experience
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.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75