I’m imagining writing something like @doc_with_sig """ Return a car with the given list of wheels and the given engine. Throws an error if `engine` doesn't have enough horsepower. """ function make_car(wheels::Vector{Wheel}, engine::Engine) such that make_car gets the docstring make_car(wheels:…

Check out SIGNATURES from DocStringExtensions , which pretty much does what you’re asking for here :slightly_smiling_face:

See also https://github.com/baggepinnen/AutomaticDocstrings.jl if you want to semi automate the creation of the docstring.

Seems useful to write a macro that prepends the method signature to the docstring?

bzinberg August 9, 2020, 5:58pm 4

Wonderful, thank you!

Topic		Replies	Views
Why is it Convention to Repeat Function Signatures in Docstrings General Usage documentation	11	785	November 10, 2024
Generate doc string with function signature New to Julia documentation	6	1647	April 30, 2019
[ANN] Small VS Code extension to help creating docstrings VS Code	9	387	November 10, 2025
[ANN] WhereIsMyDocstring.jl (aka "what do `@docs` blocks do") Package Announcements	0	192	August 22, 2024
How to get the "automatic documentation text" when documentation has been defined? General Usage	2	290	April 14, 2021