Add comment explaining usage of Spoom::TestHelpers::Project#read

Co-authored-by: Alexandre Terrasa <583144+Morriar@users.noreply.github.com>
Shopify · Mar 31, 2022 · 49d0842 · 49d0842
1 parent a2b6767
commit 49d0842
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lib/spoom/test_helpers/project.rb b/lib/spoom/test_helpers/project.rb
@@ -59,6 +59,7 @@ def files
         Dir.glob("#{@path}/**/*").sort
       end
 
+      # Return the content of the file at `rel_path`
       sig { params(rel_path: String).returns(String) }
       def read(rel_path)
         File.read(absolute_path(rel_path))