Skip to content
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.

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

Suggesting documentation improvements/enhancements #361

Open
tgkolda opened this issue Dec 16, 2024 · 0 comments
Open

Suggesting documentation improvements/enhancements #361

tgkolda opened this issue Dec 16, 2024 · 0 comments

Comments

@tgkolda
Copy link
Collaborator

tgkolda commented Dec 16, 2024

In the documentation of the tensor classes, I noticed that there are a few things that might be enhanced.

  1. For every tensor class, it says the name in all caps and then explains what it is. This is presumably leftover for porting the MATLAB documentation, where the all caps was a special indicator. I suggest to remove this in all the classes. For example, the dense tensor class help has TENSOR Class for dense tensors. and I suggest to change it to just Class for dense tensors.

  2. The __init()__ function is not linking in the help documentation. I'm not sure what the fix is here, but it's confusing. Maybe change

Instances of :class:`pyttb.tensor` can be created using `__init__()` or
    the following method:

      * :meth:`from_function`

to

Instances of :class:`pyttb.tensor` can be created as in the examples below or
    via the following method:

      * :meth:`from_function`
  1. The examples do not illustrate all the inputs. For example, in tensor there is no illustration of using shape or copy.

  2. Should creating a tensor as via eq or copy also be mentioned as ways to create a tensor?

I am specify to tensor, but these happen in all the tensor classes: tensor, sptensor, ktensor, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant