Docs: Missing docstring for apply_for_scriptable_torch function - #434
Open
kumburovicbranko682-boop wants to merge 1 commit into
Conversation
The public function apply_for_scriptable_torch lacks a docstring. This function is part of the torch.jit.script integration and users may need to understand its purpose and parameters for custom scripting scenarios. Affected files: _torch_specific.py Signed-off-by: kumburovicbranko682-boop <295886834+kumburovicbranko682-boop@users.noreply.github.com>
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.
Problem
The public function apply_for_scriptable_torch lacks a docstring. This function is part of the torch.jit.script integration and users may need to understand its purpose and parameters for custom scripting scenarios.
Severity:
mediumFile:
einops/_torch_specific.pySolution
Add a docstring explaining the function's purpose, parameters, return type, and usage context with torch.jit.script.
Changes
einops/_torch_specific.py(modified)Testing