Nick/pyttb utils improvement #353
Merged
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
* Remove unneeded method * Update examples/docs most places * Mark remaining improvements
* Update doc strings for remaining utils
* Mostly adding periods, newlines, and imperitive phrasing
|
@ntjohnson1 Looks like the same conflicts (and maybe a couple more) are still in place for this PR. Since I broke the last conflict fix, I'll ask you to fix the conflicts when you get a chance. Thanks |
|
I'll try to get to it tonight or tomorrow. |
# Conflicts: # pyttb/export_data.py # pyttb/ktensor.py # pyttb/pyttb_utils.py # pyttb/sptensor.py # pyttb/sumtensor.py # pyttb/tenmat.py # pyttb/tensor.py
|
No problem Danny I usually telescope my PRs to stack them for review but didn't this time and conflicts were a pain. I'll go back to stacking them and describe the right order of merging for the future. |
dmdunla
approved these changes
Dec 13, 2024
This was referenced Dec 13, 2024
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.
Solves #347
Also handles the [tenfun discussion]](#345 (reply in thread))
Additonally, enables ruff's enforcement of pydocstyle which should help the uniformity of our documentation. There are always documentation style improvements but I realized there were some methods we were just entirely missing docs one. (This is a single commit but if it is annoying to review can put it into a separate PR)
Resolves: #357 and #355 (the naming in the printing of the tensor will depend on #350)
📚 Documentation preview 📚: https://pyttb--353.org.readthedocs.build/en/353/