add documentation

[jacksonwalters]

most functions do not have any documentation. they should be well documented at least describing arguments and return types, as well as include some doctests.