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.

Sign up for GitHub

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

Jump to bottom

First pass over exported functions #4

Open
Shians opened this issue Jan 29, 2019 · 0 comments
Open

First pass over exported functions #4

Shians opened this issue Jan 29, 2019 · 0 comments
Projects
Solidifying API

Comments

@Shians
Copy link
Owner

Shians commented Jan 29, 2019

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 Shians added this to To do in Solidifying API via automation Jan 29, 2019
This was referenced Jan 29, 2019
Open
Open
@Shians Shians moved this from To do to In progress in Solidifying API Jan 29, 2019
@Shians Shians moved this from In progress to Done in Solidifying API Aug 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
No open projects
Solidifying API
  
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Shians