add additional documenation and attempt to satisfy rubocop