scaladoc
cap pipe (not tested)
optional: untested
sideeffect (untested)