-
Notifications
You must be signed in to change notification settings - Fork 12
Closed
Description
From openjournals/joss-reviews#8503 (comment)
For examples in the package, The
Basic Usage.ipynbnotebook is excellent. It contains clear descriptive text in markdown cells that effectively explains the purpose of the code and guides the user through the workflow. However, the other notebooks in the directory consist primarily of code cells and lack this explanatory text. This makes it a bit difficult for a user to follow the logic or understand the context behind each step. Update the other example notebooks to include descriptive markdown cells, usingBasic Usage.ipynbas a model. This will significantly improve their value as a learning resource and make the package more accessible to the community.
Metadata
Metadata
Assignees
Labels
No labels