Skip to content

Collection of small fixes#26

Merged
timholy merged 4 commits into
mainfrom
teh/api-review
May 26, 2026
Merged

Collection of small fixes#26
timholy merged 4 commits into
mainfrom
teh/api-review

Conversation

@timholy

@timholy timholy commented May 26, 2026

Copy link
Copy Markdown
Member

This single PR bundles together four commits that fix minor API issues:

  • broaden Int to Integer in several tests
  • restrict input arrays to be 1 or 2 dimensional
  • rename an inconsistent kwarg in gsvdnmf
  • clarify a docstring

Closes #25

timholy added 4 commits May 26, 2026 11:09
The Pair-form `gsvdnmf(X, n1=>n2; ...)` already uses
`tol_final`/`tol_intermediate`. The 4-arg form's `tol_nmf` meant
the same thing as `tol_final` but with a divergent name, so users
saw two keywords for one knob. This is a breaking rename, but the
next release is already breaking for unrelated reasons.
Formerly the docstring implied that `gsvdrecover` returns only the added
components, but it actually returns the full factors.
@timholy timholy merged commit 10c2127 into main May 26, 2026
2 checks passed
@timholy timholy deleted the teh/api-review branch May 26, 2026 22:33
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.

API review: modernize integer signatures, unify tolerance kwargs, tighten W/H typing, docstring fixes

1 participant