**Why?**
This function was not being used and it's
documentation was out of date.