astronomy-commons/lsdb

Make internal implementations "protected"

Open

#830 opened on Jun 13, 2025

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (21 forks)auto 404
enhancementgood first issueinterface

Repository metrics

Stars
 (54 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Explore the package structure and identify which modules and classes are intended for public use. Inspect the top level init .py to see what is reimported, and look for modules named 'internal' or 'implementation' that should be made private with an underscore prefix.
Tech stack
python
Domain
backenddeveloper experience
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75