Skip to content

general format of notebooks #15

@dbuscombe-usgs

Description

@dbuscombe-usgs

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

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