Fix PR10 error and Clean up docstrings from functions related to RT05 errors #25132
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -144,7 +144,7 @@ def strftime(self, date_format): | |
| Return an Index of formatted strings specified by date_format, which | ||
| supports the same string format as the python standard library. Details | ||
| of the string format can be found in `python string format | ||
| doc <%(URL)s>`__. | ||
|
|
||
| Parameters | ||
| ---------- | ||
|
|
@@ -154,7 +154,7 @@ def strftime(self, date_format): | |
| Returns | ||
| ------- | ||
| Index | ||
| Index of formatted strings. | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
@@ -748,7 +748,7 @@ def _maybe_mask_results(self, result, fill_value=iNaT, convert=None): | |
| mask the result if needed, convert to the provided dtype if its not | ||
| None | ||
|
|
||
| This is an internal routine. | ||
| """ | ||
|
|
||
| if self._hasnans: | ||
|
|
@@ -1047,7 +1047,7 @@ def _sub_period_array(self, other): | |
| Returns | ||
| ------- | ||
| result : np.ndarray[object] | ||
| Array of DateOffset objects; nulls represented by NaT. | ||
| """ | ||
| if not is_period_dtype(self): | ||
| raise TypeError("cannot subtract {dtype}-dtype from {cls}" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -1145,7 +1145,7 @@ def to_numpy(self, dtype=None, copy=False): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| numpy.ndarray | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -1439,7 +1439,7 @@ def from_records(cls, data, index=None, exclude=None, columns=None, | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
| """ | ||||||
|
|
||||||
| # Make a copy of the input columns so we can modify it | ||||||
|
|
@@ -1755,7 +1755,7 @@ def from_items(cls, items, columns=None, orient='columns'): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
| """ | ||||||
|
|
||||||
| warnings.warn("from_items is deprecated. Please use " | ||||||
|
|
@@ -1866,7 +1866,7 @@ def from_csv(cls, path, header=0, sep=',', index_col=0, parse_dates=True, | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -1956,7 +1956,7 @@ def to_panel(self): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Panel | ||||||
| """ | ||||||
| raise NotImplementedError("Panel is being removed in pandas 0.25.0.") | ||||||
|
|
||||||
|
|
@@ -2478,7 +2478,7 @@ def memory_usage(self, index=True, deep=False): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series | ||||||
| A Series whose index is the original column names and whose values | ||||||
| is the memory usage of each column in bytes. | ||||||
|
|
||||||
|
|
@@ -2696,7 +2696,7 @@ def get_value(self, index, col, takeable=False): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| scalar value | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| """ | ||||||
|
|
||||||
| warnings.warn("get_value is deprecated and will be removed " | ||||||
|
|
@@ -2741,9 +2741,9 @@ def set_value(self, index, col, value, takeable=False): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
| If label pair is contained, will be reference to calling DataFrame, | ||||||
| otherwise a new object. | ||||||
| """ | ||||||
| warnings.warn("set_value is deprecated and will be removed " | ||||||
| "in a future release. Please use " | ||||||
|
|
@@ -3177,7 +3177,7 @@ def select_dtypes(self, include=None, exclude=None): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
| The subset of the frame including the dtypes in ``include`` and | ||||||
| excluding the dtypes in ``exclude``. | ||||||
|
|
||||||
|
|
@@ -3542,7 +3542,7 @@ def _sanitize_column(self, key, value, broadcast=True): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| numpy-array | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| """ | ||||||
|
|
||||||
| def reindexer(value): | ||||||
|
|
@@ -3811,7 +3811,7 @@ def drop(self, labels=None, axis=0, index=None, columns=None, | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| pandas.DataFrame | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Raises | ||||||
| ------ | ||||||
|
|
@@ -3936,7 +3936,7 @@ def rename(self, *args, **kwargs): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -4579,7 +4579,7 @@ def drop_duplicates(self, subset=None, keep='first', inplace=False): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
| """ | ||||||
| if self.empty: | ||||||
| return self.copy() | ||||||
|
|
@@ -4613,7 +4613,7 @@ def duplicated(self, subset=None, keep='first'): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series | ||||||
| """ | ||||||
| from pandas.core.sorting import get_group_index | ||||||
| from pandas._libs.hashtable import duplicated_int64, _SIZE_HINT_LIMIT | ||||||
|
|
@@ -4981,7 +4981,7 @@ def swaplevel(self, i=-2, j=-1, axis=0): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| same type as caller (new object) | ||||||
|
There was a problem hiding this comment. Can you replace this by the Python type? I guess |
||||||
|
|
||||||
| .. versionchanged:: 0.18.1 | ||||||
|
|
||||||
|
|
@@ -5260,7 +5260,7 @@ def combine_first(self, other): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -5621,7 +5621,7 @@ def pivot(self, index=None, columns=None, values=None): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -5907,7 +5907,7 @@ def unstack(self, level=-1, fill_value=None): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame or Series | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -6073,7 +6073,7 @@ def diff(self, periods=1, axis=0): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -6345,7 +6345,7 @@ def apply(self, func, axis=0, broadcast=None, raw=False, reduce=None, | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series or DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -6538,7 +6538,7 @@ def append(self, other, ignore_index=False, | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -6848,7 +6848,7 @@ def round(self, decimals=0, *args, **kwargs): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
| A DataFrame with the affected columns rounded to the specified | ||||||
| number of decimal places. | ||||||
|
|
||||||
|
|
@@ -6961,7 +6961,7 @@ def corr(self, method='pearson', min_periods=1): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -7155,7 +7155,7 @@ def corrwith(self, other, axis=0, drop=False, method='pearson'): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series | ||||||
|
|
||||||
| See Also | ||||||
| ------- | ||||||
|
|
@@ -7485,7 +7485,7 @@ def nunique(self, axis=0, dropna=True): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series | ||||||
|
|
||||||
| See Also | ||||||
| -------- | ||||||
|
|
@@ -7523,7 +7523,7 @@ def idxmin(self, axis=0, skipna=True): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series | ||||||
|
|
||||||
| Raises | ||||||
| ------ | ||||||
|
|
@@ -7559,7 +7559,7 @@ def idxmax(self, axis=0, skipna=True): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series | ||||||
|
|
||||||
| Raises | ||||||
| ------ | ||||||
|
|
@@ -7706,7 +7706,7 @@ def quantile(self, q=0.5, axis=0, numeric_only=True, | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| Series or DataFrame | ||||||
|
|
||||||
| If ``q`` is an array, a DataFrame will be returned where the | ||||||
| index is ``q``, the columns are the columns of self, and the | ||||||
|
|
@@ -7788,7 +7788,7 @@ def to_timestamp(self, freq=None, how='start', axis=0, copy=True): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| DataFrame with DatetimeIndex | ||||||
|
There was a problem hiding this comment. Can you leave just |
||||||
| """ | ||||||
| new_data = self._data | ||||||
| if copy: | ||||||
|
|
@@ -7820,7 +7820,7 @@ def to_period(self, freq=None, axis=0, copy=True): | |||||
|
|
||||||
| Returns | ||||||
| ------- | ||||||
| TimeSeries with PeriodIndex | ||||||
|
There was a problem hiding this comment. I guess this returns a |
||||||
| """ | ||||||
| new_data = self._data | ||||||
| if copy: | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was there a reason for removing
PR10here or just mistake?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is just a mistake from merge.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR10is actually not included in the current check at line 245. So I wasn't sure someone excludePR10but forgot to remove from the message.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. I think this was just missed in #25109 so makes sense to update here accordingly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR10 is not passing the check withUpdate pandas.ExcelWriter.. versionadded:: 0.24.. I am going to leave PR10 for now.