update the main docstring to include new public methods