Skip to content

tensor: complete documentation for all methods #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
dmdunla opened this issue Jul 2, 2022 · 0 comments · Fixed by #216
Closed

tensor: complete documentation for all methods #20

dmdunla opened this issue Jul 2, 2022 · 0 comments · Fixed by #216
Assignees
@dmdunla
Labels
documentation Improvements or additions to documentation doing Actively being worked on
Milestone
v2.0.0

Comments

@dmdunla
Copy link
Collaborator

dmdunla commented Jul 2, 2022

No description provided.

@ntjohnson1 ntjohnson1 mentioned this issue Feb 18, 2023
Merged
@dmdunla dmdunla added this to the v2.0 milestone Mar 16, 2023
@dmdunla dmdunla added the documentation Improvements or additions to documentation label Mar 16, 2023
@dmdunla dmdunla self-assigned this Mar 16, 2023
@dmdunla dmdunla added the doing Actively being worked on label Mar 20, 2023
@dmdunla dmdunla removed the doing Actively being worked on label Jun 2, 2023
@dmdunla dmdunla added the doing Actively being worked on label Aug 24, 2023
@dmdunla dmdunla linked a pull request Aug 25, 2023 that will close this issue
20 tensor complete documentation for all methods #216
Merged
dmdunla added a commit that referenced this issue Aug 27, 2023
@dmdunla @ntjohnson1
20 tensor complete documentation for all methods (#216)
15b9cc4 
* Starting docs

* Docstrings through constructors. Fixing blankline in tensor.__str__. Aligning docstrings across classes.

* Through contract

* Through innerprod

* Completed docstring updates.

* Updating class docs to autoclass.

* FIxing black formatting.

* Update pyttb/tensor.py

Co-authored-by: Nick <[email protected]>

* Updates to address comments

* Fixing formatting

* FIxing black formatting

* FIxing doctest ELLIPSES

* Aligning function_handle across classes.

* Minor doc changes

* Changing from autoclass back to automodule

* Removing __init__ from docs

* Fix multi-line return docstring format

Closes #20

---------

Co-authored-by: Nick <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dmdunla dmdunla

Labels
documentation Improvements or additions to documentation doing Actively being worked on
Projects
None yet
Milestone
v2.0.0
Development

Successfully merging a pull request may close this issue.

20 tensor complete documentation for all methods sandialabs/pyttb
1 participant
@dmdunla