It's not what you are asking, but Lexicon/Docile has a couple of nice
features for grouping doc strings. First, to document a generic function
before it's defined, you can do:
"""
My doc string here
"""
:genericfun
genericfun(x::something1) = 1
genericfun(x::something2) = 2
You can also define
Oh, perfect. The @doc (@doc ) construction is exactly what I was looking
for. Thanks!
On Tuesday, January 13, 2015 at 2:35:09 PM UTC-6, Mike Innes wrote:
>
> That should pretty much work as is, but you'll want to use the `doc""`
> string macro for markdown formatting, i.e.
>
> recursive_ols_
That should pretty much work as is, but you'll want to use the `doc""`
string macro for markdown formatting, i.e.
recursive_ols_doc = doc"""
The other thing you can do is document one function, then retrieve that
functions docs with the @doc macro:
@doc "foo" ->
function recursi
Hi everyone, quick question about docstrings. Sometimes it makes sense
to use the same help text for different functions; I'm particularly
thinking mutating and non-mutating versions of the same algorithm. Is
there a natural way to reuse a docstring for different functions
(either in Docile.jl or i
