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

Clarify the interface #11

Open

djs55 opened this issue Jun 25, 2015 · 0 comments

Collaborator

djs55 commented Jun 25, 2015

The interface between this library and other libraries and programs is currently unclear. I suggest we start fixing this by:

auto-generate an .mli
move the obviously .mli comments from the .ml into the .mli
experimentally hide functions and see if opam downstream packages still build, hide function if so
study code and cook up some docs for the remaining undocumented functions
review the result and see if it needs further refactoring

djs55 mentioned this issue

Make the API easier to use #10

Merged

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