Skip to content

Commit 347cb79

Browse files
GarrettWushobsi
authored andcommitted
chore: expose Series.blob accessor docs (#1546)
* chore: expose blob docs * include semantic and ai * exclude sem and ai, already in frames
1 parent 83379a4 commit 347cb79

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

bigframes/operations/blob.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@
3636

3737
@log_adapter.class_logger
3838
class BlobAccessor(base.SeriesMethods):
39+
"""
40+
Blob functions for Series and Index.
41+
42+
.. note::
43+
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
44+
"""
45+
3946
def __init__(self, *args, **kwargs):
4047
if not bigframes.options.experiments.blob:
4148
raise NotImplementedError()

docs/reference/bigframes.pandas/series.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ Struct handling
5151
:inherited-members:
5252
:undoc-members:
5353

54+
Blob handling
55+
^^^^^^^^^^^^^
56+
57+
.. automodule:: bigframes.operations.blob
58+
:members:
59+
:inherited-members:
60+
:undoc-members:
61+
5462
Plotting handling
5563
^^^^^^^^^^^^^^^^^
5664

0 commit comments

Comments
 (0)