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

general format of notebooks #15

Open
4 tasks
dbuscombe-usgs opened this issue Nov 16, 2021 · 0 comments
Open
4 tasks

general format of notebooks #15

dbuscombe-usgs opened this issue Nov 16, 2021 · 0 comments

Comments

@dbuscombe-usgs
Copy link
Member

each of the notebooks needs

  • boilerplate preamble at the top of each notebook, modified to explain what the purpose of the notebook is, and how it is an example, and how it might be modified by an end user
  • Some level of code commenting (the major bits at least)
  • I think each notebook should be structured with a full example , then a piece of code at the bottom that facilitates the user to modify the example for their own purposes. This would essentially be a mere copy of the code, just structured a little differently for each task
  • use functions where appropriate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant