Missing “Public API Boundary” Explanation (Readability Issue) #11
Description
Missing “Public API Boundary” Explanation (Readability Issue)
In eesizer_core/init.py, you re-export a large number of symbols. This makes it unclear to other developers:
Should they import eesizer_core.contracts, or import from the top-level package?
Which parts are considered stable public APIs, and which are internal modules / implementation details?
✅ Suggestion: define a clear principle and document it in the README or under docs/.
For example:
Stable public APIs are only exposed via eesizer_core.contracts and a small set of eesizer_core.operators.
domain is considered internal implementation detail (or vice versa, but it needs to be fixed and explicitly stated).