Skip to content

Document the public API with tested examples - #60

Merged
timholy merged 1 commit into
mainfrom
teh/docex
Jun 28, 2026
Merged

timholy merged 1 commit into
mainfrom
teh/docex

Conversation

@timholy

@timholy timholy commented Jun 28, 2026

Copy link
Copy Markdown
Member

Add a module docstring and bring the exported functions' docstrings up
to convention: imperative mood, accurate signatures and return values,
and the colnormalize zero-column-dropping contract. Cite the NMF-Merge
publication (doi:10.1109/TSP.2025.3585893) in place of an uncited
reference.

Add jldoctest examples and exercise them via Documenter's doctest in
the test suite.

Co-Authored-By: Claude Opus 4.8 noreply@anthropic.com

Add a module docstring and bring the exported functions' docstrings up
to convention: imperative mood, accurate signatures and return values,
and the colnormalize zero-column-dropping contract. Cite the NMF-Merge
publication (doi:10.1109/TSP.2025.3585893) in place of an uncited
reference.

Add jldoctest examples and exercise them via Documenter's doctest in
the test suite.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@timholy
timholy merged commit 349b837 into main Jun 28, 2026
2 checks passed
@timholy
timholy deleted the teh/docex branch June 28, 2026 21:11
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