Skip to content

Commit 258ec1b

Browse files
YashpalAhlawatpmhatre1
authored andcommitted
DOC: docstring fix for pandas.DataFrame.where method (pandas-dev#58076)
* pandas.DataFrame.where method fixed for docstring validations * Removed additional functions fixed by change * Removed typo
1 parent fed61c8 commit 258ec1b

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

ci/code_checks.sh

-4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9898
-i "pandas.DataFrame.kurt RT03,SA01" \
9999
-i "pandas.DataFrame.kurtosis RT03,SA01" \
100100
-i "pandas.DataFrame.last_valid_index SA01" \
101-
-i "pandas.DataFrame.mask RT03" \
102101
-i "pandas.DataFrame.max RT03" \
103102
-i "pandas.DataFrame.mean RT03,SA01" \
104103
-i "pandas.DataFrame.median RT03,SA01" \
@@ -125,7 +124,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
125124
-i "pandas.DataFrame.to_timestamp SA01" \
126125
-i "pandas.DataFrame.tz_convert SA01" \
127126
-i "pandas.DataFrame.var PR01,RT03,SA01" \
128-
-i "pandas.DataFrame.where RT03" \
129127
-i "pandas.DatetimeIndex.ceil SA01" \
130128
-i "pandas.DatetimeIndex.date SA01" \
131129
-i "pandas.DatetimeIndex.day SA01" \
@@ -393,7 +391,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
393391
-i "pandas.Series.list.flatten SA01" \
394392
-i "pandas.Series.list.len SA01" \
395393
-i "pandas.Series.lt PR07,SA01" \
396-
-i "pandas.Series.mask RT03" \
397394
-i "pandas.Series.max RT03" \
398395
-i "pandas.Series.mean RT03,SA01" \
399396
-i "pandas.Series.median RT03,SA01" \
@@ -477,7 +474,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
477474
-i "pandas.Series.tz_convert SA01" \
478475
-i "pandas.Series.update PR07,SA01" \
479476
-i "pandas.Series.var PR01,RT03,SA01" \
480-
-i "pandas.Series.where RT03" \
481477
-i "pandas.SparseDtype SA01" \
482478
-i "pandas.Timedelta PR07,SA01" \
483479
-i "pandas.Timedelta.as_unit SA01" \

pandas/core/generic.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -9807,8 +9807,10 @@ def where(
98079807
98089808
Returns
98099809
-------
9810-
Series or DataFrame unless ``inplace=True`` in which case
9811-
returns None.
9810+
Series or DataFrame or None
9811+
When applied to a Series, the function will return a Series,
9812+
and when applied to a DataFrame, it will return a DataFrame;
9813+
if ``inplace=True``, it will return None.
98129814
98139815
See Also
98149816
--------

0 commit comments

Comments
 (0)