Draft: Doc update #374
Open
Draft: Doc update #374
Conversation
This file contains 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
…kolda-doc-updates
…an array of the appropriate length using the function, and then reshape it.
…ion isn't changed but the instructions are.
…n. Still missing links to methods. Only partly done.
Fixing outputs to satisfy tests.
ntjohnson1
reviewed
Jan 2, 2025
pyttb/tensor.py
Outdated
Comment on lines
82
to
83
| copy : optional bool | ||
| Whether to copy the data or reference it (default: True). |
There was a problem hiding this comment.
Global note: To hopefully avoid wasted effort.
The type hints already capture a most of the additions on these two lines and the type hints can be programmatically verified to make sure they are correct. In the help/generated documentation/ide support these should already be reflected. Both the fact that it is a bool with a default the specified default value.
If that's not coming up on your workflow could you create a discussion with details about how you are interacting with things? I'd like a significant motivation to duplicate information in a way that is more error prone.
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.
Working on various documentation updates. This already has PR #373 embedded, so I'll need to clean it up once that PRs are merged.
📚 Documentation preview 📚: https://pyttb--374.org.readthedocs.build/en/374/