Repository navigation
Name documented parameters as the signatures define them - #350
Merged
clonker merged 1 commit intoNov 14, 2026
Merged
Conversation
Six Parameters entries in markov/tools/estimation name an argument the function does not take, so the keyword form raises TypeError. - girsanov_reweighted_count_matrix and count_matrix_coo2_mult both document `reweighting`; the parameter is `reweighting_factors`. - count_matrix_coo2_mult documents `dtraj`; the parameter is `dtrajs`. - sample_tmatrix and tmatrix_sampler both document `nstep`; the parameter is `nsteps`. - transition_matrix documents `return_conv`, which appears nowhere else in the codebase. `return_statdist` directly above it is correct.
clonker
enabled auto-merge
November 14, 2026 15:03
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #350 +/- ##
=======================================
Coverage 94.03% 94.03%
=======================================
Files 141 141
Lines 11199 11199
=======================================
Hits 10531 10531
Misses 668 668
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Six
Parametersentries name an argument the function does not accept, so the rendered docs andhelp()list a parameter that cannot be passed. Same shape as #348, different mistake: that one documented wrong defaults, these document names that are not there.markov/tools/estimation/api.pygirsanov_reweighted_count_matrix:reweighting→reweighting_factorssample_tmatrix:nstep→nstepstmatrix_sampler:nstep→nstepstransition_matrix: dropped thereturn_conventry. It is not in the signature, andreturn_convappears nowhere else insrc/ortests/.markov/tools/estimation/sparse/count_matrix.pycount_matrix_coo2_mult:dtraj→dtrajs,reweighting→reweighting_factorsDescriptions, types and ordering are untouched. Only the names move, plus the one deletion.
Three I left alone
dense/ratematrix.py:258,CrommelinVandenEijndenEstimator, documentsC : (N,N) ndarrayas a "count matrix at a lag time dt", but the parameter isTand__init__raises unlessis_transition_matrix(T)holds. RenamingCtoTwould leave the text saying "count matrix", which would still be wrong, so the wording is an author's call. The other twoC : (N,N) ndarrayentries in that file, onKalbfleischLawlessEstimatorandestimate_rate_matrix, do take a count matrix and are correct as written.covariance/util/_running_moments.py,Moments.__init__, documentssandMagainst a signature of(w, sx, sy, Mxy). Splittingsintosxandsymeans writing new text for a private class, so I left it rather than guess.Glad to fold fixes for any of the three into this PR if you tell me how they should read.
AUTHORSTests: none added, the change is docstring text with no runtime behaviour to cover.
AUTHORSalready lists me as of #348, so there is nothing to add here.