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

Documentation #7

Open

tskisner opened this issue Jul 12, 2017 · 0 comments

Assignees

Labels

Milestone

Member

tskisner commented Jul 12, 2017

Before release, we need:

API reference generated by doxygen and sphinx.
Overview / philosophy discussion, including a figure that visually shows the data layout.
Section covering high-level volume operations, including creation / copying / linking / duplication.
Minimal sections on groups / dictionaries / intervals / blocks, with mainly just links to API docs.
Several meaningful examples.

tskisner added the enhancement label

tskisner added this to the Public Release milestone

tskisner self-assigned this

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