updating docs to reflect new func.