Add documentation for expectations and standards related to CLI and Python API entrypoints #25
+181
−0
Conversation
This file contains hidden or 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
…ython API entrypoints
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the CLI and Python API entrypoints, clarifying how to load, save, convert, and use speculators. Key changes include:
- Introducing a detailed guide on the design principles and usage of entrypoints.
- Providing code examples for different user scenarios such as loading, saving, and converting speculators.
- Linking to related documentation and external resources for further context.
Comments suppressed due to low confidence (1)
docs/architecture/entrypoints.md:22
- Consider ensuring consistent terminology between 'entrypoints' and 'entry points' throughout the document to improve clarity.
These entrypoints are a key component of Speculators' architecture, focusing on three core principles:
|
📦 Build Artifacts Available |
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.
Summary
Documentation and examples added to standardize the CLI and Python API entrypoints.
Testing
Self review, PR reviews