if this function is public, perhaps a brief description of the parameters in the docstring