Generate doc string with function signature

documentation

#1

Hi there,

I think I heard something like this before but I don’t remember. Is there a package/tool that generates and include function signatures in the doc string? E.g.

"""
@sig
Basically, add `x` and `y` together.
"""
add_these(x::Float64, y::Float64) = x + y

turning into something like:

"""
add_these(x::Float64, y::Float64)::Float64

Basically, add `x` and `y` together.
"""
add_these(x::Float64, y::Float64) = x + y

#2

DocStringExtensions is what you’re looking for.