From 3a67d64869c00e8bbc29b492d7028b3e9f9d5b88 Mon Sep 17 00:00:00 2001 From: Dea Leon Date: Sun, 29 Jan 2023 17:46:56 +0100 Subject: [PATCH 1/2] DOC towards fixing EX02 errors --- ci/code_checks.sh | 69 +++++++++++++++++++++++++++++++++++-- pandas/io/formats/format.py | 2 ++ 2 files changed, 69 insertions(+), 2 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index dc8784de67f13..c5d735369ae1d 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -83,7 +83,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06 RET=$(($RET + $?)) ; echo $MSG "DONE" - MSG='Partially validate docstrings (EX01)' ; echo $MSG + MSG='Partially validate docstrings (EX01)' ; echo $MSG $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \ pandas.Series.index \ pandas.Series.dtype \ @@ -574,7 +574,72 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.DataFrame.sparse.to_coo \ pandas.DataFrame.to_gbq \ pandas.DataFrame.style \ - pandas.DataFrame.__dataframe__ \ + pandas.DataFrame.__dataframe__ + RET=$(($RET + $?)) ; echo $MSG "DONE" + + MSG='Partially validate docstrings (EX02)' ; echo $MSG + $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX02 --ignore_functions \ + pandas.DataFrame.copy \ + pandas.DataFrame.plot.line \ + pandas.DataFrame.std \ + pandas.DataFrame.var \ + pandas.Index.factorize \ + pandas.Period.strftime \ + pandas.Series.factorize \ + pandas.Series.floordiv \ + pandas.Series.plot.line \ + pandas.Series.rfloordiv \ + pandas.Series.sparse.density \ + pandas.Series.sparse.npoints \ + pandas.Series.sparse.sp_values \ + pandas.Series.std \ + pandas.Series.var \ + pandas.Timestamp.fromtimestamp \ + pandas.api.types.infer_dtype \ + pandas.api.types.is_bool_dtype \ + pandas.api.types.is_categorical_dtype \ + pandas.api.types.is_complex_dtype \ + pandas.api.types.is_datetime64_any_dtype \ + pandas.api.types.is_datetime64_dtype \ + pandas.api.types.is_datetime64_ns_dtype \ + pandas.api.types.is_datetime64tz_dtype \ + pandas.api.types.is_dict_like \ + pandas.api.types.is_file_like \ + pandas.api.types.is_float_dtype \ + pandas.api.types.is_hashable \ + pandas.api.types.is_int64_dtype \ + pandas.api.types.is_integer_dtype \ + pandas.api.types.is_interval_dtype \ + pandas.api.types.is_iterator \ + pandas.api.types.is_list_like \ + pandas.api.types.is_named_tuple \ + pandas.api.types.is_numeric_dtype \ + pandas.api.types.is_object_dtype \ + pandas.api.types.is_period_dtype \ + pandas.api.types.is_re \ + pandas.api.types.is_re_compilable \ + pandas.api.types.is_signed_integer_dtype \ + pandas.api.types.is_sparse \ + pandas.api.types.is_string_dtype \ + pandas.api.types.is_timedelta64_dtype \ + pandas.api.types.is_timedelta64_ns_dtype \ + pandas.api.types.is_unsigned_integer_dtype \ + pandas.core.groupby.DataFrameGroupBy.take \ + pandas.core.groupby.SeriesGroupBy.take \ + pandas.factorize \ + pandas.io.formats.style.Styler.concat \ + pandas.io.formats.style.Styler.export \ + pandas.io.formats.style.Styler.set_td_classes \ + pandas.io.formats.style.Styler.use \ + pandas.io.json.build_table_schema \ + pandas.merge_ordered \ + pandas.option_context \ + pandas.plotting.andrews_curves \ + pandas.plotting.autocorrelation_plot \ + pandas.plotting.lag_plot \ + pandas.plotting.parallel_coordinates \ + pandas.plotting.radviz \ + pandas.tseries.frequencies.to_offset RET=$(($RET + $?)) ; echo $MSG "DONE" fi diff --git a/pandas/io/formats/format.py b/pandas/io/formats/format.py index d6a5c5fa414ed..946c22f47596e 100644 --- a/pandas/io/formats/format.py +++ b/pandas/io/formats/format.py @@ -2174,6 +2174,8 @@ def set_eng_float_format(accuracy: int = 3, use_eng_prefix: bool = False) -> Non 2 1.0 3 1.0k 4 1.0M + + >>> pd.set_option("display.float_format", None) # unset option """ set_option("display.float_format", EngFormatter(accuracy, use_eng_prefix)) From 3d346ad27344d2385c394f200f9c5e69fa03a392 Mon Sep 17 00:00:00 2001 From: Dea Leon Date: Mon, 30 Jan 2023 09:18:15 +0100 Subject: [PATCH 2/2] DOC Added pandas.Series.copy to funcs to ignore --- ci/code_checks.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index c5d735369ae1d..471b79d865566 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -585,6 +585,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.DataFrame.var \ pandas.Index.factorize \ pandas.Period.strftime \ + pandas.Series.copy \ pandas.Series.factorize \ pandas.Series.floordiv \ pandas.Series.plot.line \