nbdev icon indicating copy to clipboard operation
nbdev copied to clipboard

Render docs for methods by default

Open hamelsmu opened this issue 5 years ago • 3 comments

We should render docs for methods by default rather than requiring showdoc(...) on each method. Of course its better if people use showdoc(method) as that promotes better docs, but perhaps for people starting out it can help with initial setup?

hamelsmu avatar Oct 31 '20 17:10 hamelsmu

@hamelsmu how would you envision this working in practice?

jph00 avatar Aug 04 '22 19:08 jph00

@jph00 I'm thinking we close this? Auto documentation seems a bit of an anti pattern and you should be using patch

WDYT?

hamelsmu avatar Aug 04 '22 20:08 hamelsmu

Message ID: @.***>My view is that show_doc(A, show_all=True) for a class A should show docs for methods too.

jph00 avatar Aug 04 '22 23:08 jph00