astronomy-commons/lsdb

Make internal implementations "protected"

Offen

#830 geöffnet am 13.06.2025

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (21 Forks)auto 404
enhancementgood first issueinterface

Repository-Metriken

Stars
 (54 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Erkunde die Paketstruktur und identifiziere, welche Module und Klassen für die öffentliche Nutzung vorgesehen sind. Überprüfe das oberste init .py, um zu sehen, was reimportiert wird, und suche nach Modulen mit den Namen 'internal' oder 'implementation', die mit einem Unterstrich Präfix privat gemacht werden sollten.
Tech Stack
python
Domain
backenddeveloper experience
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75