-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: fix PR09,PR08 errors for pandas.Timestamp #28739
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.
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
DOC: fix PR09,PR08 errors for pandas.Timestamp #28739
Conversation
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.
lgtm, thanks @josibake
lgtm as well, though maybe @jbrockmendel can confirm intent on deprecated argument |
Couple of nitpicks, all of which can be follow-ups if preferred. Otherwise LGTM. |
@jbrockmendel a few open questions in my responses |
I think the ValueError edit needs tot be reverted and we need an opinion from datapythonista on a long set of literals. Once those two are addressed, LGTM. |
this also involves editing the NaT type class and Timedelta class. this is because there is a validation which enforces all of these classes to have the same docstrings closes pandas-dev#28673
based on pr feedback
2f844ab
to
1c583a5
Compare
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.
Looks good, I'd just standardize the wording to "Possible values" (replacing the "The behavior is as follows"). And move the missing ones using a backslash to a list.
Can be in a follow up too.
Thanks @josibake |
* master: (22 commits) DOC: fix PR09,PR08 errors for pandas.Timestamp (pandas-dev#28739) WEB: Add diversity note to team.md (pandas-dev#28630) DOC: Minor fixes in pandas/testing.py docstring. (pandas-dev#28752) TST: port maybe_promote tests from pandas-dev#23982 (pandas-dev#28764) Bugfix/groupby datetime issue (pandas-dev#28569) reenable codecov (pandas-dev#28750) CLN: Centralised _check_percentile (pandas-dev#27584) DEPR: Deprecate Index.set_value (pandas-dev#28621) CLN: Fix typo in contributing.rst (pandas-dev#28761) Fixed docstring errors in pandas.period range and pandas.PeriodIndex (pandas-dev#28756) BUG: Fix TypeError raised in libreduction (pandas-dev#28643) DOC: Pandas.Series.drop docstring PR02 (pandas-dev#27976) (pandas-dev#28742) DOC: Fixed doctring errors PR08, PR09 in pandas.io (pandas-dev#28748) TST: Fix broken test cases where Timedelta/Timestamp raise (pandas-dev#28729) REF: Consolidate alignment calls in DataFrame ops (pandas-dev#28638) BUG: Fix dep generation (pandas-dev#28734) Added doctstring to fixture (pandas-dev#28727) DOC: Fixed PR06 docstrings errors in pandas.timedelta_range (pandas-dev#28719) replaced safe_import with a corresponding test decorator (pandas-dev#28731) BUG: Fix RangeIndex.get_indexer for decreasing RangeIndex (pandas-dev#28680) ...
Alright, trying this again.
Note: for
Timestamp.tz_localize
, thedeprecated:: 0.24.0
was in the wrong place. the indentation implied it was only deprecating thecoerce
argument of theerrors
parameter, but if you read both of the arguments forerrors
, it implies the entire parameter is deprecated in favor ofnonexistent
(added in 0.24.0)Regarding the length of this PR, it also involved editing the NaT type class and Timedelta class. This is because there is a validation which enforces all of these classes to have the same docstrings.