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

Clarify the function of Jupyter Notebooks in the introduction #20

Open
MLDERES opened this issue Sep 26, 2022 · 0 comments
Open

Clarify the function of Jupyter Notebooks in the introduction #20

MLDERES opened this issue Sep 26, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@MLDERES
Copy link
Owner

MLDERES commented Sep 26, 2022

Is this a Jupyter Notebook or is this a book with code samples? When this was first written the intention was that it is a collection of notebooks meant to be run and interacted with, but in that way it was missing the structure and continuity of a book. Pulling it into a book gave the structure necessary for the book to be useful, but it means the language in many places and the expectations of the user change as well - like why would I tell the user to run a particular cell, if the goal is to show how a notebook works?

It might be best to address this up-front and give enough details to remind users that going to a platform where they can run the book will be best in some cases (and calling out these cases).

Suggestion: Be clear about the function of the notebook on this page and then make a call out to where a user really ought to run the book on Jupyter or Binder in order to have a better experience.

@MLDERES MLDERES added the documentation Improvements or additions to documentation label Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant