Skip to content

Add overview and descriptions to each notebook #15

@StephMcCallum

Description

@StephMcCallum

It would be nice to add a clear overview, description of the libraries being used, description of the classes being used, and description of function parameters for each notebook (or at least the basic notebooks).

An example is this flowerMD tutorial. I have experience learning and teaching from this tutorial, and find that this level of description makes it easy for users with little Python or simulation knowledge to use the library. The descriptions can mirror the doc strings, but when you are learning, it is nice to have it in one place.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions