Submission file_by_name: Improve comment

2020-10-27 01:14:13 +01:00
parent c2db083529
commit e8b02b2e0a
1 changed files with 2 additions and 0 deletions
--- a/app/models/submission.rb
+++ b/app/models/submission.rb
@ -55,6 +55,8 @@ class Submission < ApplicationRecord

  def file_by_name(file_path)
    # expects the full file path incl. file extension
+    # Caution: There must be no unnecessary path prefix included.
+    # Use `file.ext` rather than `./file.ext`
    collect_files.detect { |file| file.filepath == file_path }
  end