Skip to content

Commit

Permalink
DOC: fix RT03,SA01,ES01 for pandas.set_eng_float_format (#60135)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuhinsharma121 authored Oct 30, 2024
1 parent 71eb457 commit d25b3c2
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down
10 changes: 10 additions & 0 deletions pandas/io/formats/format.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
--------
Expand Down

0 comments on commit d25b3c2

Please sign in to comment.