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

@@ -4,9 +4,13 @@
 require "stashify/file/aws/s3"
 
 module Stashify
   class Directory
     module AWS
+      # An implementation for interacting with AWS S3 buckets as if
+      # they had directories with "/" as a path separator. In
+      # addition to a path, it also needs a Aws::S3::Bucket object
+      # representing the bucket the file resides within.
       class S3 < Stashify::Directory
         attr_reader :bucket, :path
 
         def initialize(bucket:, path:)
           @bucket = bucket