Repository navigation
docs: complete public API reference across supported interfaces - #69
Merged
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
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.
The reference previously listed many API names without enough information to use them. Document the public Python, C, Wave, and Haskell interfaces with signatures, argument and result contracts, ownership and error behavior, and examples.
Integrate every public Haskell module into the documentation site's navigation and search, and retain the API Reference at the bottom of the sidebar. Add source Haddock comments for previously undocumented functions, fields, methods, and types; runtime behavior and package versions are unchanged.
Validation:
Keep documentation-only tooling changes out of the runtime and wheel workflows while preserving the documentation build and coverage checks.