search

mfherbst / ReducedBasis.jl

Reduced basis methods for parametrised eigenproblems
https://mfherbst.github.io/ReducedBasis.jl/stable/
MIT License
14 stars 0 forks source link

Docstrings #17

Closed mfherbst closed 1 year ago

mfherbst commented 1 year ago

We should discuss our docstring policy. Right now you document a lot including some methods I would not document (e.g. the specialisations for MPS). Too many docstrings are also bad as they easily get out of date and are then misleading. Also we should integrate with DocStringExtensions.

One key question to keep in mind when writing a docstring is: Does this tell any more than the bare code or the type signature already does. If the answer is no, it's IMHO better to not document.

mfherbst commented 1 year ago

Also not all docstrings are clear to me from reading them. We should go through them together one more time. Example is in src/full_diag.jl