Updates to tensor class documentation (only at module and class level) #423
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
- Move assumed module imports into tensor.rst so that it appears at the top of the document. - Remove "TENSOR" in the class description, which is a remnant from MATLAB. - Document the attributes of the class, which before were only partly documented. - Document all the ways that a tensor can be created.
|
Direct link to modified documentation: https://pyttb--423.org.readthedocs.build/en/423/tensor.html |
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.
tensor.rstso that it appears at the top of the document.Note: This does not depend on the other PRs. There may be some minor issue with
tensor.rstdepending on the order of the merges. If there is, let me know and I can fix. There may be possible issues with crosslinks until #421 is merged, but this is sort of a pre-existing problem.📚 Documentation preview 📚: https://pyttb--423.org.readthedocs.build/en/423/