Skip to content

JOSS review on documentation - show case? #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dominiquesydow opened this issue Apr 3, 2022 · 1 comment
Closed

JOSS review on documentation - show case? #202

dominiquesydow opened this issue Apr 3, 2022 · 1 comment

Comments

@dominiquesydow
Copy link

Hi @wojdyr,

I have had a look at the documentation - great work! Thanks a lot for the many details and for providing example code snippets.
The following question is for your consideration but by no means a request given the already rich documentation.

As a novice to any package, I always welcome it if the authors provide e.g. a Jupyter notebook with a short demo of the package that shows how to use the package for a quite common task in that field. Do you by any chance have such a notebook that could be added to the repository and linked to e.g. the Introduction as a "Quick start" or "Show case" paragraph?

Link to the review: openjournals/joss-reviews#4200

@wojdyr
Copy link
Member

wojdyr commented Apr 4, 2022

Thanks for this idea. I often come across Jupyter notebooks, but I haven't tried creating them myself. So currently I don't have any. But this is something to keep in mind.

@wojdyr wojdyr closed this as completed Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants