Fix filter_and_map docstring argument order for filter_fn and is_leaf_fn#3906
Open
ayaangazali wants to merge 1 commit into
Open
Fix filter_and_map docstring argument order for filter_fn and is_leaf_fn#3906ayaangazali 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
Module.filter_and_mapdescribes thefilter_fnandis_leaf_fncallbacks as taking "a value, the key in which it is found and the containing module", but they are actually called asfilter_fn(self, k, v), i.e.(module, key, value). That also matches the type hints (Callable[[Module, str, Any], bool]) and the built-in filters likevalid_parameter_filter(module, key, value). The prose just listed the three arguments in reverse order.Reordered the description to
(module, key, value)for both callbacks. Doc only, no behavior change.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes(docstring-only, test_nn.py passes)
honest note: freshman contributor here, i use Claude Code to help spot these doc/signature mismatches but i traced the actual call site (
filter_fn(self, k, v)) and the parameter filters myself to confirm the order before opening this. let me know if i missed something.