Skip to content

Commit e3922a2

Browse files
committed
docs: add note to gcs_board docstring on auth
1 parent d04ee72 commit e3922a2

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

pins/constructors.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,14 @@ def board_gcs(path, versioned=True, cache=DEFAULT, allow_pickle_read=None):
393393
Path of form <bucket_name>/<optional>/<subdirectory>.
394394
**kwargs:
395395
Passed to the pins.board function.
396+
397+
Note
398+
----
399+
The gcs board uses the fsspec library (gcsfs) to handle interacting with
400+
google cloud storage. Currently, its default mode of authentication
401+
is supported.
402+
403+
See https://gcsfs.readthedocs.io/en/latest/#credentials
396404
"""
397405

398-
return board("gs", path, versioned, cache, allow_pickle_read)
406+
return board("gcs", path, versioned, cache, allow_pickle_read)

0 commit comments

Comments
 (0)