@jmclaus Please update doc to include what parameters this function expects, and what it returns. Please use the [JSDoc style](http://usejsdoc.org).