lib/cheripic.rb in cheripic-1.0.0 vs lib/cheripic.rb in cheripic-1.1.0

@@ -1,12 +1,18 @@
 
-# set up a golbal logger object to access across module
+# sets up a global logger object to access across module
 require 'yell'
+
+# Computing Homozygosity Enriched Regions In genomes to Prioritize Identification of Candidate variants (CHERIPIC)
+# Cheripic module provides tools and pipeline to extract potential candidate mutations
+# in around the region of the genome hosting the causative mutation behind the phenotype of interest.
 module Cheripic
 
   # custom error handling
   class CheripicError < StandardError; end
+  # custom error handling for IO
   class CheripicIOError < CheripicError; end
+  # custom error handling for Arg
   class CheripicArgError < CheripicError; end
 
   # Define a logger and pass `Object` as name.
   # Yell adds this logger to the repository where you can access it later on.
   format = Yell::Formatter.new('[%5L] %d : %m', '%Y-%m-%d %H:%M:%S')