Improved docs for from_url (#138)

Author: kylebarron

obstore/python/obstore/store/_aws.pyi

@@ -237,6 +237,11 @@ class S3Store:
         - `https://<bucket>.s3.<region>.amazonaws.com`
         - `https://ACCOUNT_ID.r2.cloudflarestorage.com/bucket`
 
+        !!! note
+            Note that `from_url` will not use any additional parts of the path as a
+            bucket prefix. It will only extract the bucket, region, and endpoint. If you
+            wish to use a path prefix, consider wrapping this with `PrefixStore`.
+
         Args:
             url: well-known storage URL.
 

obstore/python/obstore/store/_azure.pyi

@@ -198,6 +198,11 @@ class AzureStore:
         - `https://<account>.blob.fabric.microsoft.com`
         - `https://<account>.blob.fabric.microsoft.com/<container>`
 
+        !!! note
+            Note that `from_url` will not use any additional parts of the path as a
+            bucket prefix. It will only extract the container name, account name, and
+            whether it's a fabric endpoint. If you wish to use a path prefix, consider
+            wrapping this with `PrefixStore`.
 
         Args:
             url: well-known storage URL.

obstore/python/obstore/store/_gcs.pyi

@@ -92,6 +92,11 @@ class GCSStore:
 
         - `gs://<bucket>/<path>`
 
+        !!! note
+            Note that `from_url` will not use any additional parts of the path as a
+            bucket prefix. It will only extract the bucket name. If you wish to use a
+            path prefix, consider wrapping this with `PrefixStore`.
+
         Args:
             url: well-known storage URL.
 

obstore/python/obstore/store/_http.pyi

@@ -16,6 +16,10 @@ class HTTPStore:
     ) -> HTTPStore:
         """Construct a new HTTPStore from a URL
 
+        !!! note
+            Note that in contrast to the other stores, `from_url` **will** use the full
+            URL provided here as a prefix for further operations.
+
         Args:
             url: The base URL to use for the store.