astronomy-commons/lsdb

Make internal implementations "protected"

開放

#830 建立於 2025年6月13日

 (0 則留言) (1 個反應) (0 位負責人)Python (21 個分叉)auto 404
enhancementgood first issueinterface

倉庫指標

星標
 (54 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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.

貢獻者指南