Make submodules private #28
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prefix submodule names with an underscore to indicate that they're not intended to be accessed by downstream projects. Only symbols exposed in the top-level namespace should be considered public. I don't want to treat the locations of symbols in individual submodules as part of the API -- I'd prefer to be able to reorganize things in the future without causing breaking changes. In the future, we might add public submodules (such as a `tophu.typing` submodule for custom type annotations) to store public symbols that don't belong in the top-level namespace. But, for now, every symbol that's intended to be public should be importable directly from `tophu`.
Codecov Report
@@ Coverage Diff @@
## main #28 +/- ##
==========================================
- Coverage 97.55% 97.45% -0.11%
==========================================
Files 8 8
Lines 696 668 -28
==========================================
- Hits 679 651 -28
Misses 17 17
|
|
any chance you could make (i found it useful enough that I stuck it in as a temporary easter egg while tophu was being remodeled |
Yeah, it's on my list. I have an old half-finished branch somewhere with the necessary changes. Just need to clean it up and add a unit test. Thanks for the heads up. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prefix submodule names with an underscore to indicate that they're not intended to be accessed by downstream projects.
Only symbols exposed in the top-level namespace should be considered public. We don't want to treat the locations of symbols in individual submodules as part of the API. Instead, we'd prefer to be able to reorganize things in the future without causing breaking changes.
In the future, we might add public submodules (such as a
tophu.typingsubmodule for custom type annotations) to store public symbols that don't belong in the top-level namespace. But, for now, every symbol that's intended to be public should be importable directly fromtophu.