reference guide

pola-rs · Jan 20, 2025 · c66fcdf · c66fcdf
1 parent 80a6595
commit c66fcdf
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/py-polars/docs/source/reference/catalog.rst b/py-polars/docs/source/reference/catalog.rst
@@ -0,0 +1,20 @@
+=======
+Catalog
+=======
+.. currentmodule:: polars
+
+
+Unity Catalog
+~~~~~~~~~~~~~
+
+Interface with Unity catalogs.
+
+.. autosummary::
+   :toctree: api/
+
+   Catalog
+   Catalog.list_catalogs
+   Catalog.list_schemas
+   Catalog.list_tables
+   Catalog.get_table_info
+   Catalog.scan_table
diff --git a/py-polars/docs/source/reference/index.rst b/py-polars/docs/source/reference/index.rst
@@ -65,6 +65,13 @@ methods. All classes and functions exposed in the ``polars.*`` namespace are pub
 
            io
 
+    .. grid-item-card::
+
+        .. toctree::
+           :maxdepth: 2
+
+           catalog
+
     .. grid-item-card::
 
         .. toctree::

diff --git a/py-polars/polars/catalog.py b/py-polars/polars/catalog.py
@@ -44,7 +44,7 @@ def __init__(
             Bearer token to authenticate with. This can also be set to:
             * "auto": Automatically retrieve bearer tokens from the environment.
             * "databricks-sdk": Use the Databricks SDK to retrieve and use the
-              bearer token from the environment.
+            bearer token from the environment.
         """
         from polars.polars import PyCatalogClient
 
@@ -160,7 +160,7 @@ def scan_table(
         table_name
             Name of the table.
         delta_table_version
-            Version of the table to scan.
+            Version of the table to scan (Deltalake only).
         delta_table_options
             Additional keyword arguments while reading a Deltalake table.
         storage_options
@@ -187,7 +187,6 @@ def scan_table(
                 at any point without it being considered a breaking change.
         retries
             Number of retries if accessing a cloud instance fails.
-        version
 
         """
         table_info = self.get_table_info(catalog_name, schema_name, table_name)