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

Missing docstring and minor errors in documentation

Open albinahlback opened this issue 4 years ago • 4 comments

Scrolling through the documentation for Hecke I saw some minor errors.

For example, at https://www.thofma.com/Hecke.jl/dev/orders/orders/ there is a missing docstring for denominator and a \Z at the first docstring (should probably be \mathbf{Z}).

albinahlback avatar Feb 17 '21 20:02 albinahlback

Also the "Source" hyperref does not link anywhere. It opens a tab which contain a link under the name "None".

albinahlback avatar Feb 17 '21 20:02 albinahlback

The long equation has a greater width than the text does. In some cases (but not the one shown here) it causes a cut-off at the end. Screenshot from 2021-02-18 00-51-40

albinahlback avatar Feb 17 '21 23:02 albinahlback

Missing docstring for maximal_order(::AnticNumberField, ::Array{fmpz, 1}).

albinahlback avatar Feb 18 '21 00:02 albinahlback

There are some missing in docstrings in /Order, but I can't seem to find out why some of them behave that way. For example, I think class_group should be well-behaved, but it's missing.

albinahlback avatar Feb 18 '21 00:02 albinahlback