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: """…

DocStringExtensions is what you’re looking for.

DocStringExtensions works great but it provides a list with signatures from all methods ( using $(SIGNATURES)). Is there a way to add only the signature of the method being documented?

Not at the moment, but I would be happy to review a PR for that.

I saw that DocStringExtensions uses the methods function which brings all signatures. I do not know how to get the signature from the current method. Actually, I do not know how to get a handle for the current method being documented.

I think you can base most of the code on SIGNATURES, except instead of getting all the methods , just use the single one. If you don’t want to do this, I can make a PR, I wanted this functionality too for a long time.

Generate doc string with function signature

New to Julia

RaulDurand April 30, 2019, 11:30am 7

Please feel free to submit a PR.

Topic		Replies	Views
[ANN] Small VS Code extension to help creating docstrings VS Code	9	387	November 10, 2025
Why is it Convention to Repeat Function Signatures in Docstrings General Usage documentation	11	785	November 10, 2024
Seems useful to write a macro that prepends the method signature to the docstring? Internals & Design	3	569	August 9, 2020
How to get the "automatic documentation text" when documentation has been defined? General Usage	2	290	April 14, 2021
[ANN] WhereIsMyDocstring.jl (aka "what do `@docs` blocks do") Package Announcements	0	192	August 22, 2024

Generate doc string with function signature

Related topics