format documentation

besides the missing examples which already have an issue, the documentation looks a bit messy at the moment. I would follow the tidyverse style guide as described here https://style.tidyverse.org/documentation.html especially concerning adding a space after #' to make the docs more readable.