Repository navigation
docs: standardize API contracts and numerical guides - #70
Merged
LunaStev merged 3 commits intoOct 28, 2026
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.
Readers could find API names but had to infer argument contracts, numerical assumptions, and the next useful operation. Expand the reference and task guides using the content conventions of NumPy/SciPy and Haddock, while preserving the existing site and API links.
Only documentation, documentation tooling, and documentation-related workflow configuration change. Library sources, interfaces, README, and version files are unchanged. No package release is required.
Validation: strict site build and links, all 26 Python examples, all five complete Haskell programs, the compiled C borrowed-storage example, negative reference-validation cases, Ruff, actionlint, and whitespace checks.