Reorder Tensor documentations such that it can be displayed correctly#171
Merged
Conversation
We found that `_strict_dims` was placed before the main `Tensor` class documentation, which caused the generated docs / linter to associate the docstrings incorrectly and not show the attribute in the proper place. Rearrange the class documentation so the `Tensor` docstring remains the class docstring and `_strict_dims` is documented as a class attribute where tools can pick it up correctly.
Alphaharrius
added
bug
Alphaharrius
changed the title
Tensor documentations such that it can be displayed correctly
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
2 participants
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.
See #164
Summary
We found that
_strict_dimswas placed before the mainTensorclass documentation, which caused the generated docs / linter to associate the docstrings incorrectly and not show the attribute in the proper place.Rearrange the class documentation so the
Tensordocstring remains the class docstring and_strict_dimsis documented as a class attribute where tools can pick it up correctly.