astronomy-commons / astronomy-commons/lsdb

Make internal implementations "protected"

Open
#830 0 comments 1 reaction 0 assignees View on GitHub
enhancement good first issue interface
Dominant language
Python
Stars
55
Forks
26
Avg merge
4d 1h
Merged PRs (30d)
8

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

No contributing guide indexed for this repository

Research direction

Begin by inventorying the package's internal and implementation modules and classes, including the examples `lsdb._dask` and `lsdb._nested`, along with public objects reimported in the top `__init__.py`. Review issue #767 for related API HTML documentation context. Done means the intended internal names are consistently prefixed and unwanted public reexports no longer appear in IDE completion or HTML documentation search results.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.