Add comment on skip_signature=True in the s3 store example (#731)

jbusecke · maxrjones · web-flow · commit 791c4faabd5d · 2025-07-30T10:50:47.000-07:00
* Add comment on skip_signature=True in the s3 store example

I am refactoring some of my code to virtualize NASA data to v2 at the moment, and just spent a bunch of minutes debugging a permission denied error due to me just copy/pasting the code in the example. 

Wondering if it would be instructive for users to know that this option is specific to the data used.

* Update docs/migration_guide.md

---------

Co-authored-by: Max Jones &lt;14077947+maxrjones@users.noreply.github.com&gt;
diff --git a/docs/migration_guide.md b/docs/migration_guide.md
@@ -39,7 +39,7 @@ for reading the original data, but some parsers may accept an empty [ObjectStore
     store = S3Store(
         bucket=bucket,
         region="us-west-2",
-        skip_signature=True
+        skip_signature=True # required for this specific example data because the data is in a public bucket, so the S3Store shouldn't fetch and use credentials.
     )
     registry = ObjectStoreRegistry({f"s3://{bucket}": store})
     parser = HDFParser()

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ for reading the original data, but some parsers may accept an empty [ObjectStore`
`39`	`39`	`store = S3Store(`
`40`	`40`	`bucket=bucket,`
`41`	`41`	`region="us-west-2",`
`42`		`- skip_signature=True`
	`42`	`+ skip_signature=True # required for this specific example data because the data is in a public bucket, so the S3Store shouldn't fetch and use credentials.`
`43`	`43`	`)`
`44`	`44`	`registry = ObjectStoreRegistry({f"s3://{bucket}": store})`
`45`	`45`	`parser = HDFParser()`