doc - improve internal API documentation #1834
Merged
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
jeremylt
force-pushed
the
jeremy/internal-docs
branch
from
492c12b to
a43f799
Compare
jeremylt
force-pushed
the
jeremy/internal-docs
branch
from
a43f799 to
86fd8a6
Compare
jrwrigh
reviewed
Jun 12, 2025
Co-authored-by: James Wright <[email protected]>
jrwrigh
reviewed
Jun 12, 2025
nbeams
reviewed
Jun 12, 2025
jrwrigh
reviewed
Jun 13, 2025
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.
fixes #1767
Ok, this is an effort to better explain the internal API and overall design. Is this helpful? Did I miss things you'd like to see?