Skip to content
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

Merged

Conversation

josibake
Copy link

@josibake josibake commented Oct 1, 2019

Alright, trying this again.

Note: for Timestamp.tz_localize , the deprecated:: 0.24.0 was in the wrong place. the indentation implied it was only deprecating the coerce argument of the errors parameter, but if you read both of the arguments for errors, it implies the entire parameter is deprecated in favor of nonexistent (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.

Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks @josibake

@WillAyd WillAyd added the Docs label Oct 2, 2019
@WillAyd WillAyd added this to the 1.0 milestone Oct 2, 2019
@WillAyd
Copy link
Member

WillAyd commented Oct 2, 2019

lgtm as well, though maybe @jbrockmendel can confirm intent on deprecated argument

@jbrockmendel
Copy link
Member

Couple of nitpicks, all of which can be follow-ups if preferred. Otherwise LGTM.

@josibake
Copy link
Author

josibake commented Oct 2, 2019

@jbrockmendel a few open questions in my responses

@jbrockmendel
Copy link
Member

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.

Josiah Baker added 3 commits October 4, 2019 00:01
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
Copy link
Member

@datapythonista datapythonista left a 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.

@WillAyd WillAyd merged commit ac39473 into pandas-dev:master Oct 4, 2019
@WillAyd
Copy link
Member

WillAyd commented Oct 4, 2019

Thanks @josibake

galuhsahid added a commit to galuhsahid/pandas that referenced this pull request Oct 4, 2019
* 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)
  ...
@josibake josibake deleted the docstrings-pr09-pr08-timestamp-fix branch October 4, 2019 17:58
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
bongolegend pushed a commit to bongolegend/pandas that referenced this pull request Jan 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOCS: fix PR09,PR09 doc string errors in Timestamp, NaT, Timedelta class
4 participants