From 979e4c03f90b17ceda008dbda99b8de4a612c9ec Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Fri, 5 Nov 2021 20:34:46 -0700 Subject: [PATCH 1/4] DOC: remove min_rows from DataFrame.to_html --- pandas/core/frame.py | 3 +++ pandas/io/formats/format.py | 3 --- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 4e7f6329bb73b..2ddb72bd28212 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -1078,6 +1078,9 @@ def to_string( %(shared_params)s line_width : int, optional Width to wrap a line in characters. + min_rows : int, optional + The number of rows to display in the console in a truncated repr + (when number of rows is above `max_rows`). max_colwidth : int, optional Max width to truncate each column in characters. By default, no limit. diff --git a/pandas/io/formats/format.py b/pandas/io/formats/format.py index ba85a1b340d05..ca53bfb7d5e08 100644 --- a/pandas/io/formats/format.py +++ b/pandas/io/formats/format.py @@ -164,9 +164,6 @@ * unset. max_rows : int, optional Maximum number of rows to display in the console. - min_rows : int, optional - The number of rows to display in the console in a truncated repr - (when number of rows is above `max_rows`). max_cols : int, optional Maximum number of columns to display in the console. show_dimensions : bool, default False From b6a79294df107844c2315be76022e8cc8788e0e9 Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Fri, 5 Nov 2021 22:27:01 -0700 Subject: [PATCH 2/4] Update for docstring validation --- pandas/core/frame.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 2ddb72bd28212..b97175cc57fd3 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -1065,11 +1065,11 @@ def to_string( index_names: bool = True, justify: str | None = None, max_rows: int | None = None, - min_rows: int | None = None, max_cols: int | None = None, show_dimensions: bool = False, decimal: str = ".", line_width: int | None = None, + min_rows: int | None = None, max_colwidth: int | None = None, encoding: str | None = None, ) -> str | None: @@ -2841,15 +2841,14 @@ def to_html( border : int A ``border=border`` attribute is included in the opening `` tag. Default ``pd.options.display.html.border``. - encoding : str, default "utf-8" - Set character encoding. - - .. versionadded:: 1.0 - table_id : str, optional A css id is included in the opening `
` tag if specified. render_links : bool, default False Convert URLs to HTML links. + encoding : str, default "utf-8" + Set character encoding. + + .. versionadded:: 1.0 %(returns)s See Also -------- From 0829b6ad0af24148b36943f1ef0534e33fb60e4d Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Mon, 15 Nov 2021 20:20:34 -0800 Subject: [PATCH 3/4] Adding change to release note for 1.4 --- doc/source/whatsnew/v1.4.0.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/source/whatsnew/v1.4.0.rst b/doc/source/whatsnew/v1.4.0.rst index e30e9026e6327..e7e41edad443f 100644 --- a/doc/source/whatsnew/v1.4.0.rst +++ b/doc/source/whatsnew/v1.4.0.rst @@ -730,6 +730,7 @@ Other - Bug in :meth:`Series.to_frame` and :meth:`Index.to_frame` ignoring the ``name`` argument when ``name=None`` is explicitly passed (:issue:`44212`) - Bug in :meth:`Series.replace` and :meth:`DataFrame.replace` with ``value=None`` and ExtensionDtypes (:issue:`44270`) - Bug in :meth:`FloatingArray.equals` failing to consider two arrays equal if they contain ``np.nan`` values (:issue:`44382`) +- Change in the order of the arguments in :meth:`DataFrame.to_string` due to change in the docstring (:issue:`44304`) - .. ***DO NOT USE THIS SECTION*** From b6d0888c07a5b6566e7bf2f33cde59857e97b243 Mon Sep 17 00:00:00 2001 From: Loic Diridollou Date: Mon, 15 Nov 2021 20:24:12 -0800 Subject: [PATCH 4/4] Adding release note for issue 44304 --- doc/source/whatsnew/v1.4.0.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/whatsnew/v1.4.0.rst b/doc/source/whatsnew/v1.4.0.rst index e7e41edad443f..b796bb5b8e570 100644 --- a/doc/source/whatsnew/v1.4.0.rst +++ b/doc/source/whatsnew/v1.4.0.rst @@ -211,6 +211,7 @@ Other enhancements - :meth:`.GroupBy.mean` now supports `Numba `_ execution with the ``engine`` keyword (:issue:`43731`) - :meth:`Timestamp.isoformat`, now handles the ``timespec`` argument from the base :class:``datetime`` class (:issue:`26131`) - :meth:`NaT.to_numpy` ``dtype`` argument is now respected, so ``np.timedelta64`` can be returned (:issue:`44460`) +- Change in the order of the arguments in :meth:`DataFrame.to_string` due to change in the docstring (:issue:`44304`) - .. --------------------------------------------------------------------------- @@ -730,7 +731,6 @@ Other - Bug in :meth:`Series.to_frame` and :meth:`Index.to_frame` ignoring the ``name`` argument when ``name=None`` is explicitly passed (:issue:`44212`) - Bug in :meth:`Series.replace` and :meth:`DataFrame.replace` with ``value=None`` and ExtensionDtypes (:issue:`44270`) - Bug in :meth:`FloatingArray.equals` failing to consider two arrays equal if they contain ``np.nan`` values (:issue:`44382`) -- Change in the order of the arguments in :meth:`DataFrame.to_string` due to change in the docstring (:issue:`44304`) - .. ***DO NOT USE THIS SECTION***