lib/stashify/file/aws/s3.rb in stashify-aws-s3-1.1.0 vs lib/stashify/file/aws/s3.rb in stashify-aws-s3-1.2.0

@@ -3,9 +3,12 @@
 require "stashify/file"
 
 module Stashify
   class File
     module AWS
+      # An implementation for interacting with files in AWS S3
+      # buckets. The constructor needs an instance of Aws::S3::Bucket
+      # order to know which bucket to interact with.
       class S3 < Stashify::File
         def initialize(bucket:, path:)
           @bucket = bucket
           super(path: path)
         end