add some documentation on how to use these functions