CellBench icon indicating copy to clipboard operation
CellBench copied to clipboard

First pass over exported functions

Open Shians opened this issue 7 years ago • 0 comments

Check exported functions and

  • Check for adequate documentation
  • Check examples are runnable
  • Check arguments are consistent with other API within package
  • Consider categorisation of function
  • Consider if it should be made private

Check private functions and

  • Consider if it is useful to expose
  • Add "." prefix to indicate private
  • Add any missing imports

Shians avatar Jan 29 '19 03:01 Shians