Skip to content
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

[JOSS review] Add more information in the tutorial notebooks #577

Closed
martibosch opened this issue Jan 11, 2021 · 1 comment
Closed

[JOSS review] Add more information in the tutorial notebooks #577

martibosch opened this issue Jan 11, 2021 · 1 comment
Assignees
Projects

Comments

@martibosch
Copy link

The notebooks from the tutorial provide a very easy way (especially with the Binder badges) for the users to interactively follow the tutorial, nonetheless they could have more text explaining the functionalities that they showcase. This might not be much of an issue for and advanced user who can infer many information from the context and browse the API documentation and source code of the classes and methods used in the notebooks, yet I think that with the current notebooks, many users will not know what to do other than hitting enter to execute each cell sequentially. I believe that the user guides of momepy (https://docs.momepy.org/en/stable/user_guide/intro.html) or OSMnx (https://github.com/gboeing/osmnx-examples) are great examples of a thorough tutorials.
openjournals/joss-reviews#2826

@jGaboardi jGaboardi added this to To do in JOSS paper Jan 15, 2021
@jGaboardi jGaboardi moved this from To do to In progress in JOSS paper Mar 7, 2021
@jGaboardi jGaboardi self-assigned this Mar 7, 2021
@jGaboardi
Copy link
Member

We have updated the Quickstart tutorial (see #578) and will use it as an example in the future for improving other currently existing tutorials. This issue is tagged in #604 for our future work/wishlist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
JOSS paper
  
Done
Development

No branches or pull requests

2 participants