Fix cholesky_inv documented argument name to match the binding - #3950
Open
ayaangazali wants to merge 1 commit into
Open
Fix cholesky_inv documented argument name to match the binding#3950ayaangazali wants to merge 1 commit into
ayaangazali wants to merge 1 commit into
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.
Proposed changes
cholesky_invadvertises its first argument asLin bothnb::sigand the docstring, but the bound keyword isa, so the documented call fails:I fixed the signature and docstring to say
arather than renaming the bound argument, for two reasons: every other binding inlinalg.cppuses"a"_a, and renaming would break anyone already callinga=. Since the surrounding math usesLfor the Cholesky factor andAfor the original matrix, I also spelled out in the arg description that the input is the factor, so the rename does not read as "pass A here".If you would rather go the other way and rename the bound argument to
L, that is a one word change and I am happy to switch it.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes(docs only, no behavior change; rebuilt CPU-only and checked the rendered signature,
test_linalg.pypasses)usual disclosure: i'm a freshman and Claude Code helps me catch this sort of drift, but i ran both calls above myself, checked the other linalg bindings to see which name was the odd one out, and rebuilt to confirm the signature renders correctly. glad to be told if you prefer the other direction.