docs(python): Fix docs for sink_parquet (#5952)

Signed-off-by: Chitral Verma <chitralverma@gmail.com>
pola-rs · Dec 30, 2022 · d11600f · d11600f
1 parent 8e40353
commit d11600f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/py-polars/docs/source/reference/lazyframe/miscellaneous.rst b/py-polars/docs/source/reference/lazyframe/miscellaneous.rst
@@ -13,6 +13,7 @@ Miscellaneous
     LazyFrame.map
     LazyFrame.pipe
     LazyFrame.profile
+    LazyFrame.sink_parquet
 
 
 Read/write logical plan

diff --git a/py-polars/polars/internals/lazyframe/frame.py b/py-polars/polars/internals/lazyframe/frame.py
@@ -1194,10 +1194,9 @@ def sink_parquet(
         slice_pushdown: bool = True,
     ) -> pli.DataFrame:
         """
-        Collect into a DataFrame.
+        Persists a LazyFrame at the provided path.
 
-        Note: use :func:`fetch` if you want to run your query on the first `n` rows
-        only. This can be a huge time saver in debugging queries.
+        This allows streaming results that are larger than RAM to be written to disk.
 
         Parameters
         ----------
@@ -1243,6 +1242,15 @@ def sink_parquet(
         slice_pushdown
             Slice pushdown optimization.
 
+        Returns
+        -------
+        DataFrame
+
+        Examples
+        --------
+        >>> ldf = pl.scan_csv("/path/to/my_larger_than_ram_file.csv")  # doctest: +SKIP
+        >>> ldf.sink_parquet("/tmp/out.parquet")  # doctest: +SKIP
+
         """
         if no_optimization:
             predicate_pushdown = False