Skip to content

Refactoring notebooks #5

Description

@iled

Hey all,

Following the lead by @eeholmes, I have started to refactor code out of the notebooks. The goal is to extract code that can be reused elsewhere.

For now, these efforts are being done in the refactoring branch. Note: this tutorial of the hackweek has more info on branches.

Notebooks whose functions have been refactored so far:

  • DataDownload/OpenAltimetry_example.ipynb by @eeholmes
  • DataDownload/SlideRule_example.ipynb by @eeholmes

TODO:

  • improve docstrings (documentation in the code, see coastal/plot.py/plot_from_oa_url for a good example)
  • refactor code that was not in functions defined within the notebooks but that can be moved to one
  • rewrite the notebooks to use the functions already refactored and test them

This issue will be updated as more notebooks are refactored.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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