lib/ach/file.rb in ach_builder-0.2.1 vs lib/ach/file.rb in ach_builder-0.2.2

- old
+ new

@@ -43,11 +43,14 @@ include Builder include TransmissionHeader has_many :batches, :proc_defaults => lambda{ {:batch_number => batches.length + 1} } - # Opens a +filename+ and passes it's handler to the ACH::Reader object, which uses it as - # enum to scan for ACH contents line by line. + # Open a +filename+ and pass its handler to the ACH::Reader object, + # which uses it as an enum to scan for ACH contents line by line. + # + # @param [String] filename + # @return [ACH::File] def self.read(filename) ::File.open(filename) do |fh| Reader.new(fh).to_ach end end