Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format for all docstrings for a particular function #160

Open
tomerarnon opened this issue Oct 5, 2023 · 0 comments
Open

Format for all docstrings for a particular function #160

tomerarnon opened this issue Oct 5, 2023 · 0 comments

Comments

@tomerarnon
Copy link

tomerarnon commented Oct 5, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant