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

Allow docstrings in interface definition

Open SBuercklin opened this issue 8 months ago • 0 comments

It'd be convenient to support something like the following syntax for documenting interfaces:

@required Foo begin
    "This is a docstring for bar(::Foo))"
    bar(::Foo)
end

There are ways of working around this, e.g. we can use @doc or just define docstrings as

"This is a docstring for bar(::Foo)"
bar

SBuercklin avatar Jun 24 '24 17:06 SBuercklin