Add function signature in documentation about krylov.jl HOT 5 CLOSED

I'm quite excited about https://juliadocs.github.io/DocStringExtensions.jl/stable/#DocStringExtensions.SIGNATURES

from krylov.jl.

DocStringExtensions.jl works quite well when the functions are not parametrized but in our case the solvers depend on T, the floating-point system. The signature only appears in the docstring for some random methods when I tested it. Another drawback of the signature generated by DocStringExtensions is that the output arguments are not given.

Signatures of our Krylov solvers are not updated often, I updated the docstrings with #208.

from krylov.jl.

I think we should iterate with the DocstringsExtensions.jl authors to see if it's possible to get the result we want. It's a general principle that doesn't only apply to Krylov.jl.

I'm not worried about the output parameters. We usually describe those in a section of the docstring and that's sufficient.

from krylov.jl.

@mtanneau, does #238 solve your problem?

from krylov.jl.

@amontoison yes :) Thanks.

from krylov.jl.