Would be good to add yard docs for this method.  Due to the way these methods get defined at runtime, yard doesn't pick them up if we put the docs directly above them.  Instead, see the bottom of this file -- the docs are there.