this is probably better as docs on top of the function definition, instead of as first line inside the function.