Skip to content

docs: complete public API reference across supported interfaces - #69

Merged
LunaStev merged 1 commit into
wavefnd:masterfrom
LunaStev:docs/complete-api-reference
Oct 28, 2026
Merged

LunaStev merged 1 commit into
wavefnd:masterfrom
LunaStev:docs/complete-api-reference

Conversation

@LunaStev

Copy link
Copy Markdown
Member

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:

  • Strict site build passes; all 349 HTML pages have valid local links and anchors.
  • Automated coverage checks pass for 32 Python entries, 44 C functions, 15 Wave functions, 2,476 Haskell functions/methods/fields, and 363 Haskell types.
  • All 23 Python examples and the complete C, Wave, and Haskell example programs execute successfully.
  • Ruff, actionlint, Fourmolu, and whitespace checks pass.

Keep documentation-only tooling changes out of the runtime and wheel workflows while preserving the documentation build and coverage checks.

@LunaStev
LunaStev merged commit eb03625 into wavefnd:master Oct 28, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant