DOCS-#4628: add to_parquet partial support notes (#4648)

Signed-off-by: Dave Bunten <dave@bntn.net> Co-authored-by: Mahesh Vashishtha <mvashishtha@users.noreply.github.com>
modin-project · Jul 7, 2022 · 9b33451 · 9b33451
1 parent 35ae834
commit 9b33451
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/release_notes/release_notes-0.16.0.rst b/docs/release_notes/release_notes-0.16.0.rst
@@ -39,6 +39,7 @@ Key Features and Updates
   * TEST-#2564: Add caching and use mamba for conda setups in GH (#4607)
 * Documentation improvements
   * DOCS-#4552: Change default sphinx language to en to fix sphinx >= 5.0.0 build (#4553)
+  * DOCS-#4628: Add to_parquet partial support notes (#4648)
 * Dependencies
   * FEAT-#4598: Add support for pandas 1.4.3 (#4599)
   * FEAT-#4619: Integrate mypy static type checking (#4620)
@@ -56,3 +57,4 @@ Contributors
 @RehanSD
 @helmeleegy
 @anmyachev
+@d33bs
diff --git a/docs/supported_apis/dataframe_supported.rst b/docs/supported_apis/dataframe_supported.rst
@@ -418,7 +418,15 @@ default to pandas.
 +----------------------------+---------------------------+------------------------+----------------------------------------------------+
 | ``to_latex``               | `to_latex`_               | D                      |                                                    |
 +----------------------------+---------------------------+------------------------+----------------------------------------------------+
-| ``to_parquet``             | `to_parquet`_             | D                      |                                                    |
+| ``to_parquet``             | `to_parquet`_             | P                      | **Dask**: Defaults to Pandas implementation and    |
+|                            |                           |                        | writes a  single output file.                      |
+|                            |                           |                        | **Ray**: Parallel implementation only if path      |
+|                            |                           |                        | parameter is a string; does not end with ".gz",    |
+|                            |                           |                        | ".bz2", ".zip", or ".xz"; and compression parameter|
+|                            |                           |                        | is not ``None`` or "snappy". In these cases, the   |
+|                            |                           |                        | ``path`` parameter specifies a directory where     |
+|                            |                           |                        | one file is written per row partition of the Modin |
+|                            |                           |                        | dataframe.                                         |
 +----------------------------+---------------------------+------------------------+----------------------------------------------------+
 | ``to_period``              | `to_period`_              | D                      |                                                    |
 +----------------------------+---------------------------+------------------------+----------------------------------------------------+