docs: fix recursively_apply docstring to document test_type instead of nonexistent main_type#4079
Open
Kropiunig wants to merge 1 commit into
Open
Conversation
…f nonexistent main_type
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
1 participant
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.
The
recursively_applydocstring insrc/accelerate/utils/operations.pydocuments an argument namedmain_type, but the function signature has no such parameter; the actual parameter istest_type(test_type=is_torch_tensor). The ghost name also appears in thedatadescription, theerror_on_other_typedescription, and the Returns section. This renames everymain_typereference totest_typeso the rendered API reference matches the real signature. Docstring-only change with no behavior impact.