docs: ensure that PlotAccessor is included in the API reference

packages/bigframes/bigframes/_tools/docs.py

@@ -34,6 +34,20 @@ def decorator(target_class):
                         except AttributeError:
                             pass
 
+                        underlying = None
+                        if isinstance(target_item, property):
+                            underlying = target_item.fget
+                        elif hasattr(target_item, "__func__"):
+                            underlying = target_item.__func__
+                        elif hasattr(target_item, "func"):
+                            underlying = getattr(target_item, "func", None)
+
+                        if underlying is not None:
+                            try:
+                                underlying.__doc__ = source_item.__doc__
+                            except AttributeError:
+                                pass
+
         return target_class
 
     return decorator

packages/bigframes/bigframes/pandas/api/typing.py

@@ -21,12 +21,14 @@
 from bigframes.core.groupby.series_group_by import SeriesGroupBy
 from bigframes.core.window import Window
 from bigframes.operations.datetimes import DatetimeMethods
+from bigframes.operations.plotting import PlotAccessor
 from bigframes.operations.strings import StringMethods
 from bigframes.operations.structs import StructAccessor, StructFrameAccessor
 
 __all__ = [
     "DataFrameGroupBy",
     "DatetimeMethods",
+    "PlotAccessor",
     "SeriesGroupBy",
     "StringMethods",
     "StructAccessor",

packages/bigframes/docs/templates/toc.yml

@@ -42,7 +42,7 @@
       - name: DataFrame
         uid: bigframes.dataframe.DataFrame
       - name: PlotAccessor
-        uid: bigframes.operations.plotting.PlotAccessor
+        uid: bigframes.pandas.api.typing.PlotAccessor
       - name: StructAccessor
         uid: bigframes.operations.structs.StructFrameAccessor
       name: DataFrame
@@ -86,7 +86,7 @@
       - name: ListAccessor
         uid: bigframes.operations.lists.ListAccessor
       - name: PlotAccessor
-        uid: bigframes.operations.plotting.PlotAccessor
+        uid: bigframes.pandas.api.typing.PlotAccessor
       name: Series
     - name: Window
       uid: bigframes.core.window.Window

packages/bigframes/third_party/bigframes_vendored/pandas/core/frame.py

@@ -7335,7 +7335,7 @@ def plot(self):
         Make plots of Dataframes.
 
         Returns:
-            bigframes.operations.plotting.PlotAccessor:
+            bigframes.pandas.api.typing.PlotAccessor:
                 An accessor making plots.
         """
         raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

packages/bigframes/third_party/bigframes_vendored/pandas/core/series.py

@@ -5450,7 +5450,7 @@ def plot(self):
             <Axes: title={'center': 'My plot'}, ylabel='Frequency'>
 
         Returns:
-            bigframes.operations.plotting.PlotAccessor:
+            bigframes.pandas.api.typing.PlotAccessor:
                 An accessor making plots.
         """
         raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)