Skip to content

Commit d25b3c2

Browse files
DOC: fix RT03,SA01,ES01 for pandas.set_eng_float_format (#60135)
1 parent 71eb457 commit d25b3c2

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
144144
-i "pandas.io.stata.StataWriter.write_file SA01" \
145145
-i "pandas.plotting.andrews_curves RT03,SA01" \
146146
-i "pandas.plotting.scatter_matrix PR07,SA01" \
147-
-i "pandas.set_eng_float_format RT03,SA01" \
148147
-i "pandas.tseries.offsets.BDay PR02,SA01" \
149148
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
150149
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \

pandas/io/formats/format.py

+10
Original file line numberDiff line numberDiff line change
@@ -1926,6 +1926,9 @@ def set_eng_float_format(accuracy: int = 3, use_eng_prefix: bool = False) -> Non
19261926
"""
19271927
Format float representation in DataFrame with SI notation.
19281928
1929+
Sets the floating-point display format for ``DataFrame`` objects using engineering
1930+
notation (SI units), allowing easier readability of values across wide ranges.
1931+
19291932
Parameters
19301933
----------
19311934
accuracy : int, default 3
@@ -1936,6 +1939,13 @@ def set_eng_float_format(accuracy: int = 3, use_eng_prefix: bool = False) -> Non
19361939
Returns
19371940
-------
19381941
None
1942+
This method does not return a value. it updates the global display format
1943+
for floats in DataFrames.
1944+
1945+
See Also
1946+
--------
1947+
set_option : Set the value of the specified option or options.
1948+
reset_option : Reset one or more options to their default value.
19391949
19401950
Examples
19411951
--------

0 commit comments

Comments
 (0)