summarize the methods rather than paste them with all the type information
At the moment, yes. Having things a little bit more automated to avoid
signatures becoming out-of-sync with the methods would definitely be good
to have at some point though.
— Mike
On Sunday, 25 October 2015 15:34:0
Thank you for the detailed answer! It makes sense. Looking at the docs for
built-ins, I take it that good Julia documentation style should summarize
the methods rather than paste them with all the type information, but it's
cool that it's a possibility.
On Sunday, October 25, 2015 at 3:15:54 A
Is it an oversight that ?draw_rectangle does not show methods if a
docstring is present
It’s the expected behaviour.
If you’d like to have a method table show up when searching for function
docs then you can do something like
module M
"""
f(x)
...
"""
f(x) = x
"""
f(x, y)
...
"""