Skip to content

docs: standardize API contracts and numerical guides - #70

Merged
LunaStev merged 3 commits into
wavefnd:masterfrom
LunaStev:docs/standard-reference-guides
Oct 28, 2026
Merged

LunaStev merged 3 commits into
wavefnd:masterfrom
LunaStev:docs/standard-reference-guides

Conversation

@LunaStev

Copy link
Copy Markdown
Member

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.

  • Give all 32 Python entries, 44 C functions, and 15 Wave functions a purpose index, ordered argument/type tables, separate result/error sections, and related API links.
  • Group 96 Haskell modules by numerical domain and index all 3,390 exported symbols, including constructors, methods, and record fields. Add detailed QR contracts and connect the generated module pages to task guides.
  • Add operation selection, matrix validation, least-squares, calculus, statistics, and C borrowed-storage guides, with equations, expected results, cleanup, and numerical limitations.
  • Validate source signatures, parameter order/defaults, native status values, generated symbol coverage, and local links. Run Python documentation examples against the released package in the documentation workflow.
  • Generate the documentation version from existing package metadata and document the writing standard for contributors.

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.

@LunaStev
LunaStev merged commit f90e8a8 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