Api redesign #120
Merged
Api redesign #120
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
- Everyone else is cast into subpackages of pt
- Required given the doc render settings
- all this info should go in docs/
- Basic functions that operate on basic data types have been migrated into ptmath. This means physics subpackage is now a high-level package that handles complex types like System
- ruleset uses Ball objects which is problematic for fully-connected subpackage sharing with GameType
…o api-redesign
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.
Before this, the top-level API was an unorganized collection of objects. Now, members who are graduated to the top-level API are picked more stringently, and lesser used members (who are nonetheless important) have to be accessed from their submodules/subpackages.
This API is more discerning about what makes it to the top-level API, while also providing better access to lesser used members. I.e.
import pooltool as ptis sufficient for accessing nearly every member in the codebase.