TensorOperations.jl icon indicating copy to clipboard operation
TensorOperations.jl copied to clipboard

?TensorOperations shows no docstring

Open mrtntome opened this issue 5 years ago • 3 comments

Can't access the package documentation from the REPL.

mrtntome avatar Apr 15 '20 18:04 mrtntome

What do you mean by package documentation? There are doc strings for the most common functions and macros. The module itself does not have a docstring. I can add one if you like, but it wouldn't provide much help in itself I assume?

Jutho avatar Apr 17 '20 21:04 Jutho

I was thinking, a line like the the beginning of the readme.md and a list of the available macros and functions with a little description.

mrtntome avatar Apr 19 '20 22:04 mrtntome

You could leave this open; I haven't had time for it but I am not opposed to doing this, so leaving it open is a good reminder.

Jutho avatar Apr 28 '20 07:04 Jutho