Skip to content

DOC: fix RT03,SA01,ES01 for pandas.set_eng_float_format #60135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2024
Merged

DOC: fix RT03,SA01,ES01 for pandas.set_eng_float_format #60135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48e7f26
DOC: fix RT03,SA01,ES01 for pandas.set_eng_float_format
tuhinsharma121 Oct 30, 2024
4d1ff0e
Merge branch 'main' into pandas.set_eng_float_format
tuhinsharma121 Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
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
View file
Open in desktop
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
Loading