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

Documentation of internal functions #4

Open
hypirion opened this issue Aug 2, 2014 · 0 comments
Open

Documentation of internal functions #4

hypirion opened this issue Aug 2, 2014 · 0 comments
Labels
Milestone

Comments

@hypirion
Copy link
Owner

hypirion commented Aug 2, 2014

The essence of the algorithms manipulating the RRB-tree are described properly in my thesis, but is rather academic in nature and contains a lot of proofs.

The technicalities, however, aren't described as they are language-specific. To ease portability and understanding of the source, I'd like to add in proper explanation of each function, along with some comments on why things are done in the fashion they are. While I've tried to document some strange quirks, it's far from done.

Additionally, there's a big mismatch between development/master and experimental. Adding in some explanation on how experimental relates to development would be handy.

@hypirion hypirion added this to the 1.0.0 milestone Aug 2, 2014
@hypirion hypirion added the docs label Aug 2, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant