-
Notifications
You must be signed in to change notification settings - Fork 515
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
E.g. don't put everything into docstrings. Use markdown cells in notebooks. Show examples of exceptions. Use tests to show expected behavior. Use pictures, plots, etc...
Useful notes in this comment from @seeM : #964 (comment)
There are also open questions for nbdev-style docs, like whether we could/should have a parameter table for object attributes, raises, and "see also" blocks (this page from numpy docs demonstrates a few of these).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation