Skip to content

Improve examples #219

@domna

Description

@domna

From openjournals/joss-reviews#8503 (comment)

For examples in the package, The Basic Usage.ipynb notebook 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, using Basic Usage.ipynb as a model. This will significantly improve their value as a learning resource and make the package more accessible to the community.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions