added full docstring for users