for completeness - document parameters docstring.