Merge pull request #22 from saalfeldlab/hanslovsky-patch-1

Use createBucket instead of bucketName for documenting bucket creation
saalfeldlab · Oct 23, 2023 · e30da8f · e30da8f
2 parents ef05d1e + bdf6f8a
commit e30da8f
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/main/java/org/janelia/saalfeldlab/n5/s3/AmazonS3KeyValueAccess.java b/src/main/java/org/janelia/saalfeldlab/n5/s3/AmazonS3KeyValueAccess.java
@@ -75,8 +75,8 @@ public class AmazonS3KeyValueAccess implements KeyValueAccess {
 	/**
 	 * Opens an {@link AmazonS3KeyValueAccess} using an {@link AmazonS3} client and a given bucket name.
 	 *
-	 * If the bucket does not exist and {@code bucketName==true}, the bucket will be created.
-	 * If the bucket does not exist and {@code bucketName==false}, the bucket will not be
+	 * If the bucket does not exist and {@code createBucket==true}, the bucket will be created.
+	 * If the bucket does not exist and {@code createBucket==false}, the bucket will not be
 	 * created and all subsequent attempts to read attributes, groups, or datasets will fail.
 	 *
 	 * @param s3 the s3 instance