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

Format for all docstrings for a particular function

Open tomerarnon opened this issue 2 years ago • 0 comments

I would like a docstring for my many-method functions to look like:

    f(x::Int, y::Float)
Does something with `x` and `y`. 
defined at [blah.jl:100](link)
- - - 
    f(x::String)
Does something with a string.
defined at [blah.jl:120](link)
- - -
    f(x::Int, y::Int, z::Int)
Does a completely different thing
defined at [elsewhere.jl:5](link)
- - -
    f(b::Blah)                             # note: these last two don't have docstrings, but I still want them listed here.
defined at [elsewhere.jl:15](link)
- - -
    f(a, b)
defined at [elsewhere.jl:30](link)

It's some combination of typedsignatures + methodlist, but not quite either of them.... Is this achievable with any of the abbreviations/combinations in DocStringExtensions?

tomerarnon avatar Oct 05 '23 20:10 tomerarnon