DOC: Add examples for pandas.tseries.timedeltas #11785
Merged
Conversation
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
| @@ -32,6 +32,20 @@ def to_timedelta(arg, unit='ns', box=True, errors='raise', coerce=None): | |||
| Returns | |||
| ------- | |||
| ret : timedelta64/arrays of timedelta64 if parsing succeeded | |||
|
|
|||
| Examples | |||
| -------- | |||
There was a problem hiding this comment.
You did something strange with the indentation here
|
@proinsias Thanks a lot for working on examples in docstrings! Besides the inline comments, another general: maybe it would be nice to have some text between the different examples to somehow put them a bit into context, eg: |
|
Thanks for the advice! – I've made these changes and re-pushed the branch. |
| -------- | ||
|
|
||
| Parsing a single string to a Timedelta: | ||
| >>> pd.to_timedelta('1 days 06:05:01.00003') |
There was a problem hiding this comment.
Small formatting note: there needs to be a blank line between the two lines above (between the code blocks and the text, so the code blocks are rendered as code, see https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#sections for a full reference)
Copied examples from pandas-docs/stable/timedeltas.html.
jreback
added a commit
that referenced
this pull request
Dec 16, 2015
DOC: Add examples for pandas.tseries.timedeltas
|
thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Copied examples from the reStructuredText tutorial on timedeltas.