This is an automated email from the ASF dual-hosted git repository. ruifengz pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push: new 8ee22d9358e [SPARK-45114][PYTHON][DOCS] Adjust the `versionadded` and `versionchanged` information to the parameters 8ee22d9358e is described below commit 8ee22d9358e945b0631abef123fbfd52c91505bc Author: Ruifeng Zheng <ruife...@apache.org> AuthorDate: Mon Sep 11 19:41:28 2023 +0800 [SPARK-45114][PYTHON][DOCS] Adjust the `versionadded` and `versionchanged` information to the parameters ### What changes were proposed in this pull request? 1, for newly added parameters, using `versionadded` instead of `versionchanged`, to follow pandas https://github.com/pandas-dev/pandas/blob/cea0cc0a54725ed234e2f51cc21a1182674a6032/pandas/io/sql.py#L317 2, for newly changed parameters, move `versionchanged` under the corresponding parameter ### Why are the changes needed? for better doc ### Does this PR introduce _any_ user-facing change? yes ### How was this patch tested? CI ### Was this patch authored or co-authored using generative AI tooling? NO Closes #42867 from zhengruifeng/py_doc_minor. Authored-by: Ruifeng Zheng <ruife...@apache.org> Signed-off-by: Ruifeng Zheng <ruife...@apache.org> --- python/pyspark/sql/catalog.py | 12 ++++-------- python/pyspark/sql/dataframe.py | 39 +++++++++++++++++++-------------------- 2 files changed, 23 insertions(+), 28 deletions(-) diff --git a/python/pyspark/sql/catalog.py b/python/pyspark/sql/catalog.py index 2c6ed28461f..e2b31e0e556 100644 --- a/python/pyspark/sql/catalog.py +++ b/python/pyspark/sql/catalog.py @@ -129,8 +129,7 @@ class Catalog: pattern : str The pattern that the catalog name needs to match. - .. versionchanged: 3.5.0 - Added ``pattern`` argument. + .. versionadded: 3.5.0 Returns ------- @@ -201,8 +200,7 @@ class Catalog: pattern : str The pattern that the database name needs to match. - .. versionchanged: 3.5.0 - Adds ``pattern`` argument. + .. versionadded: 3.5.0 Returns ------- @@ -325,8 +323,7 @@ class Catalog: pattern : str The pattern that the database name needs to match. - .. versionchanged: 3.5.0 - Adds ``pattern`` argument. + .. versionadded: 3.5.0 Returns ------- @@ -455,8 +452,7 @@ class Catalog: pattern : str The pattern that the function name needs to match. - .. versionchanged: 3.5.0 - Adds ``pattern`` argument. + .. versionadded: 3.5.0 Returns ------- diff --git a/python/pyspark/sql/dataframe.py b/python/pyspark/sql/dataframe.py index eaed565ed0e..74da285ff1e 100644 --- a/python/pyspark/sql/dataframe.py +++ b/python/pyspark/sql/dataframe.py @@ -597,8 +597,7 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin): level : int, optional, default None How many levels to print for nested schemas. - .. versionchanged:: 3.5.0 - Added Level parameter. + .. versionadded:: 3.5.0 Examples -------- @@ -2864,14 +2863,14 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin): .. versionchanged:: 3.4.0 Supports Spark Connect. - .. versionchanged:: 4.0.0 - Supports column ordinal. - Parameters ---------- cols : int, str, list or :class:`Column`, optional list of :class:`Column` or column names or column ordinals to sort by. + .. versionchanged:: 4.0.0 + Supports column ordinal. + Other Parameters ---------------- ascending : bool or list, optional, default True @@ -2928,14 +2927,14 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin): .. versionchanged:: 3.4.0 Supports Spark Connect. - .. versionchanged:: 4.0.0 - Supports column ordinal. - Parameters ---------- cols : int, str, list, or :class:`Column`, optional list of :class:`Column` or column names or column ordinals to sort by. + .. versionchanged:: 4.0.0 + Supports column ordinal. + Other Parameters ---------------- ascending : bool or list, optional, default True @@ -3826,16 +3825,16 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin): .. versionchanged:: 3.4.0 Supports Spark Connect. - .. versionchanged:: 4.0.0 - Supports column ordinal. - Parameters ---------- - cols : list, str or :class:`Column` + cols : list, str, int or :class:`Column` The columns to group by. Each element can be a column name (string) or an expression (:class:`Column`) or a column ordinal (int, 1-based) or list of them. + .. versionchanged:: 4.0.0 + Supports column ordinal. + Returns ------- :class:`GroupedData` @@ -3935,16 +3934,16 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin): .. versionchanged:: 3.4.0 Supports Spark Connect. - .. versionchanged:: 4.0.0 - Supports column ordinal. - Parameters ---------- - cols : list, str or :class:`Column` + cols : list, str, int or :class:`Column` The columns to roll-up by. Each element should be a column name (string) or an expression (:class:`Column`) or a column ordinal (int, 1-based) or list of them. + .. versionchanged:: 4.0.0 + Supports column ordinal. + Returns ------- :class:`GroupedData` @@ -4020,16 +4019,16 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin): .. versionchanged:: 3.4.0 Supports Spark Connect. - .. versionchanged:: 4.0.0 - Supports column ordinal. - Parameters ---------- - cols : list, str or :class:`Column` + cols : list, str, int or :class:`Column` The columns to cube by. Each element should be a column name (string) or an expression (:class:`Column`) or a column ordinal (int, 1-based) or list of them. + .. versionchanged:: 4.0.0 + Supports column ordinal. + Returns ------- :class:`GroupedData` --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org