Skip to content

Best practices for notebook development #980

@jph00

Description

@jph00

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).

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions