fastai / nbdev

Create delightful software with Jupyter Notebooks
https://nbdev.fast.ai/
Apache License 2.0
4.88k stars 489 forks source link

Render docs for methods by default #293

Open hamelsmu opened 3 years ago

hamelsmu commented 3 years ago

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?

jph00 commented 2 years ago

@hamelsmu how would you envision this working in practice?

hamelsmu commented 2 years ago

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

WDYT?

jph00 commented 2 years ago

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