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.

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

Document and enforce public vs private API #69

Open
MatthewPeterKelly opened this issue May 3, 2018 · 1 comment
Open

Document and enforce public vs private API #69

MatthewPeterKelly opened this issue May 3, 2018 · 1 comment

Comments

@MatthewPeterKelly
Copy link
Contributor

All functions and classes in the library are currently part of the public API, although many are intended to be for internal use only. We should decide what will be part of the public API (for focus on thorough documentation) and what should be part of the private API (easier to clean-up the code without worrying about breaking things with every change to a private function).

  1. Decide what will be in the public API
  2. Decide how to separate the private and public sections of the code
  3. Implement!
@rethink-forrest
Copy link

Step 4. Profit!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant