Skip to content

DOC: Improve docstring of Timedelta.delta #21135

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 13 commits into from
Closed

DOC: Improve docstring of Timedelta.delta #21135

wants to merge 13 commits into from

Conversation

chalmerlowe
Copy link
Contributor

  • closes #xxxx
  • tests added / passed
  • passes git diff upstream/master -u -- "*.pyx" | flake8 --diff
  • whatsnew entry
################################################################################
###################### Docstring (pandas.Timedelta.delta) ######################
################################################################################

Return the timedelta in nanoseconds (ns), for internal compatibility.

Returns
-------
int
    Timedelta in nanoseconds.

Examples
--------
**Using string input**

>>> td = pd.Timedelta('1 days 42 ns')
>>> td.delta
86400000000042

>>> td = pd.Timedelta('3 s')
>>> td.delta
3000000000

>>> td = pd.Timedelta('3 ms 5 us')
>>> td.delta
3005000

**Using integer input**

>>> td = pd.Timedelta(42, unit='ns')
>>> td.delta
42

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
	No extended summary found
	See Also section not found

chalmerlowe added 13 commits May 15, 2018 12:12
@chalmerlowe
updated docstring for nanoseconds function
4dcb4b4
@chalmerlowe
Merge remote-tracking branch 'upstream/master' into nanosecond-docstring
e0ae113
@chalmerlowe
DOC: updated docstring for nanoseconds function per doc guidelines
11a9266
@chalmerlowe
DOC: added examples to nanoseconds function and minor formatting edits
04e204b
@chalmerlowe
DOC: added example header
5ac6ef1
@chalmerlowe
DOC: added example header and space
fb45759
@chalmerlowe
DOC: fixed minor spelling error
b0977f4
@chalmerlowe
removed trailing whitespace, long lines
85bcb52
@chalmerlowe
Merge remote-tracking branch 'upstream/master' into nanosecond-docstring
841611e
@chalmerlowe
DOC: updates to docstring for nanoseconds function per doc guidelines
4237391
@chalmerlowe
DOC: documentation guide update to resolution docstring
5035798
@chalmerlowe
Merge remote-tracking branch 'upstream/master' into delta-docstring
3a2fd38
@chalmerlowe
DOCL: Improve the docstring of Timedelta.delta
e18e685
@chalmerlowe chalmerlowe changed the title Delta docstring DOC: Improve docstring of Timedelta.delta May 19, 2018
WillAyd
WillAyd requested changes May 19, 2018
View reviewed changes
pandas/_libs/tslibs/timedeltas.pyx
@@ -770,7 +799,48 @@ cdef class _Timedelta(timedelta):

@property
def resolution(self):
""" return a string representing the lowest resolution that we have """
"""
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this already a part of #21122?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@WillAyd

Yes...
I am not sure why that is in there.
I created separate branches for each of the changes I am proposing to:

  • delta
  • resolution
  • nanoseconds

etcetera, but the commit stream above seems to be sucking all of them into this PR.
super confused.

Copy link
Member

Choose a reason for hiding this comment

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

Hmm this should just reflect what you have locally - any chance you merged your branches there accidentally?

Copy link
Contributor

Choose a reason for hiding this comment

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

when creating a new branch, do it off of upstream/master (or if you keep a local master then off of this). each branch should be independent.

you will need to revert the resolution part of this change (as its in the other PR). or can just close that one and do it here is ok too)

jreback
jreback requested changes May 19, 2018
View reviewed changes
pandas/_libs/tslibs/timedeltas.pyx
@@ -770,7 +799,48 @@ cdef class _Timedelta(timedelta):

@property
def resolution(self):
""" return a string representing the lowest resolution that we have """
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

when creating a new branch, do it off of upstream/master (or if you keep a local master then off of this). each branch should be independent.

you will need to revert the resolution part of this change (as its in the other PR). or can just close that one and do it here is ok too)

@jreback jreback added Docs Timedelta Timedelta data type labels May 19, 2018
@chalmerlowe chalmerlowe mentioned this pull request May 19, 2018
Merged
4 tasks
@chalmerlowe
Copy link
Contributor Author

i did some looking at how to git rid of (pun intended) a bunch of the changes that are cluttering up the works.
think I am gonna just close this, try to submit a new pull request starting with a clean slate.
See PR #21138

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@WillAyd WillAyd WillAyd requested changes

@jreback jreback jreback requested changes

Assignees
No one assigned
Labels
Docs Timedelta Timedelta data type
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@chalmerlowe @WillAyd @jreback