From 48e7f26b8c8f6830c26cfcda76efc5a9df50d57b Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Wed, 30 Oct 2024 16:03:41 +0530 Subject: [PATCH] DOC: fix RT03,SA01,ES01 for pandas.set_eng_float_format --- ci/code_checks.sh | 1 - pandas/io/formats/format.py | 10 ++++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index b727d93879a86..7e3998c01cce6 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -144,7 +144,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.io.stata.StataWriter.write_file SA01" \ -i "pandas.plotting.andrews_curves RT03,SA01" \ -i "pandas.plotting.scatter_matrix PR07,SA01" \ - -i "pandas.set_eng_float_format RT03,SA01" \ -i "pandas.tseries.offsets.BDay PR02,SA01" \ -i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \ -i "pandas.tseries.offsets.BQuarterBegin.n GL08" \ diff --git a/pandas/io/formats/format.py b/pandas/io/formats/format.py index 5aecc6af712e5..861f5885f80c6 100644 --- a/pandas/io/formats/format.py +++ b/pandas/io/formats/format.py @@ -1926,6 +1926,9 @@ def set_eng_float_format(accuracy: int = 3, use_eng_prefix: bool = False) -> Non """ Format float representation in DataFrame with SI notation. + Sets the floating-point display format for ``DataFrame`` objects using engineering + notation (SI units), allowing easier readability of values across wide ranges. + Parameters ---------- accuracy : int, default 3 @@ -1936,6 +1939,13 @@ def set_eng_float_format(accuracy: int = 3, use_eng_prefix: bool = False) -> Non Returns ------- None + This method does not return a value. it updates the global display format + for floats in DataFrames. + + See Also + -------- + set_option : Set the value of the specified option or options. + reset_option : Reset one or more options to their default value. Examples --------