Merge pull request #1105 from samvera-labs/docs

Update documentation

app/jobs/characterize_job.rb

@@ -1,6 +1,8 @@
 class CharacterizeJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
+  # Characterizes the file at 'filepath' if available, otherwise, pulls a copy from the repository
+  # and runs characterization on that file.
   # @param [FileSet] file_set
   # @param [String] file_id identifier for a Hydra::PCDM::File
   # @param [String, NilClass] filepath the cached file within the Hyrax.config.working_path

app/jobs/ingest_file_job.rb

@@ -30,8 +30,7 @@ def perform(file_set, filepath, user, opts = {})
     # Do post file ingest actions
     Hyrax::VersioningService.create(repository_file, user)
 
-    # TODO: this is a problem, the file may not be available at this path on another machine.
-    # It may be local, or it may be in s3
+    # In another worker, characterize the uploaded file.
     CharacterizeJob.perform_later(file_set, repository_file.id, filepath)
   end
 end

app/services/hyrax/working_directory.rb

@@ -1,6 +1,8 @@
 module Hyrax
   class WorkingDirectory
     class << self
+      # Returns the file passed as filepath if that file exists. Otherwise it grabs the file from repository,
+      # puts it on the disk and returns that path.
       # @param [String] repository_file_id identifier for Hydra::PCDM::File
       # @param [String] id the identifier of the FileSet
       # @param [String, NilClass] filepath path to existing cached copy of the file