lib/csv_decision/load.rb in csv_decision-0.0.6 vs lib/csv_decision/load.rb in csv_decision-0.0.7

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
 # CSV Decision: CSV based Ruby decision tables.
-# Created December 2017 by Brett Vickers
+# Created December 2017.
+# @author Brett Vickers <[e-mail]>
 # See LICENSE and README.md for details.
 module CSVDecision
   # Load all the CSV files located in the designated folder path.
   #
-  # @param path [Pathname] - directiory containing CSV files
-  # @param options [Hash] - supplied options hash for table creation
+  # @param path [Pathname] Directory containing CSV files.
+  # @param options [Hash] Options hash used for table creation.
   # @return [Hash<CSVDecision::Table>]
+  # @raise [ArgumentError] Invalid folder.
   def self.load(path, options = {})
     Load.path(path: path, options: options)
   end
 
   # Load all CSV files located in the specified folder.
+  # @api private
   module Load
+    # (see CSVDecision.load)
     def self.path(path:, options:)
       raise ArgumentError, 'path argument must be a Pathname' unless path.is_a?(Pathname)
       raise ArgumentError, 'path argument not a valid folder' unless path.directory?
 
       tables = {}
\ No newline at end of file