Skip to content

First pass over exported functions #4

@Shians

Description

@Shians

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions