search

sandialabs / pyttb

Python Tensor Toolbox
https://pyttb.readthedocs.io
BSD 2-Clause "Simplified" License
26 stars 13 forks source link

20 tensor complete documentation for all methods #216

Closed dmdunla closed 1 year ago

dmdunla commented 1 year ago

Updating docstrings, doctests.

:books: Documentation preview :books:: https://pyttb--216.org.readthedocs.build/en/216/

ntjohnson1 commented 1 year ago

Is this waiting on review from me or still WIP? I assume the sptensor bug came up when looking over our documentation stuff

dmdunla commented 1 year ago

Thanks, still working ... I'll explicitly request a review when ready.

dmdunla commented 1 year ago

Looks good to me. A variety of small fixes/notes.

One global style note. I think it is nice to have full print outs of tensor contents to be explicit, however it does add to maintenance efforts if we ever change the format of the display. Luckily doctest will catch it pretty immediately. I guess since you are the one who just did the doc updates you are in the best position to state if that's a worthwhile tradeoff.

I went back and forth on this. I think this provides users with examples of what they should see. Since we clear the tutorial notebooks, these docs provide a way to see what pyttb does before you start running it (or while you are trying to determine if it is doing what you want).