DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta #20142

ijmbarr · 2018-03-10T14:03:36Z

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

[X ] PR title is "DOC: update the docstring"
The validation script passes: scripts/validate_docstrings.py <your-function-or-method>
The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
The html version looks good: python doc/make.py --single <your-function-or-method>
It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

################# Docstring (pandas.Series.dt.to_pytimedelta)  #################
################################################################################

Return an array of the Timedeltas in `datetime.timedelta` format with
the same length as the original Series.

Returns
-------
a : numpy.ndarray
    1D array containing data with `datetime.timedelta` type

Examples
--------
>>> s = pd.Series(pd.to_timedelta(np.arange(5), unit='d'))
>>> s
0   0 days
1   1 days
2   2 days
3   3 days
4   4 days
dtype: timedelta64[ns]
>>> s.dt.to_pytimedelta()
array([datetime.timedelta(0), datetime.timedelta(1),
       datetime.timedelta(2), datetime.timedelta(3),
       datetime.timedelta(4)], dtype=object)

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

Errors found:
        No summary found (a short summary in a single line should be present at the beginning of the docstring)
        See Also section not found

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.

No extended summary needed.

Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):

closes #xxxx
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

cemsbr · 2018-03-10T14:15:03Z

pandas/core/indexes/accessors.py

@@ -157,6 +157,30 @@ class TimedeltaProperties(Properties):
    """

    def to_pytimedelta(self):
+        """
+        Return an array of the Timedeltas in `datetime.timedelta` format with


Missing single-line summary in the beginning.

cemsbr · 2018-03-10T14:17:22Z

pandas/core/indexes/accessors.py

+        Returns
+        -------
+        a : numpy.ndarray
+            1D array containing data with `datetime.timedelta` type


Full stop missing.

jreback · 2018-03-10T17:03:45Z

pandas/core/indexes/accessors.py

+
+        Examples
+        --------
+        >>> s = pd.Series(pd.to_timedelta(np.arange(5), unit='d'))


I think we need import datetime here

I don't seem to need the import, but to clarify things, I've added more to the description.

jreback · 2018-03-10T17:04:09Z

pandas/core/indexes/accessors.py

+        3   3 days
+        4   4 days
+        dtype: timedelta64[ns]
+        >>> s.dt.to_pytimedelta()


can you add a blank line before this case

pep8speaks · 2018-03-10T18:07:17Z

Hello @ijmbarr! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on March 17, 2018 at 12:09 Hours UTC

jorisvandenbossche

Looks good!

codecov · 2018-03-17T12:09:48Z

Codecov Report

Merging #20142 into master will decrease coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #20142      +/-   ##
==========================================
- Coverage   91.72%   91.72%   -0.01%     
==========================================
  Files         150      150              
  Lines       49156    49152       -4     
==========================================
- Hits        45090    45086       -4     
  Misses       4066     4066

Flag	Coverage Δ
#multiple	`90.11% <ø> (-0.01%)`	⬇️
#single	`41.84% <ø> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/indexes/accessors.py	`90.19% <ø> (ø)`	⬆️
pandas/core/base.py	`96.78% <0%> (-0.02%)`	⬇️
pandas/core/series.py	`93.85% <0%> (-0.01%)`	⬇️
pandas/core/indexes/base.py	`96.66% <0%> (-0.01%)`	⬇️
pandas/core/generic.py	`95.84% <0%> (ø)`	⬆️
pandas/core/indexes/multi.py	`95.06% <0%> (ø)`	⬆️
pandas/plotting/_core.py	`82.23% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 840d432...48ca62c. Read the comment docs.

jorisvandenbossche · 2018-03-17T12:10:06Z

Thanks @ijmbarr !

…ame_describe * upstream/master: (158 commits) Add link to "Craft Minimal Bug Report" blogpost (pandas-dev#20431) BUG: fixed json_normalize for subrecords with NoneTypes (pandas-dev#20030) (pandas-dev#20399) BUG: ExtensionArray.fillna for scalar values (pandas-dev#20412) DOC" update the Pandas core window rolling count docstring" (pandas-dev#20264) DOC: update the pandas.DataFrame.plot.hist docstring (pandas-dev#20155) DOC: Only use ~ in class links to hide prefixes. (pandas-dev#20402) Bug: Allow np.timedelta64 objects to index TimedeltaIndex (pandas-dev#20408) DOC: add disallowing of Series construction of len-1 list with index to whatsnew (pandas-dev#20392) MAINT: Remove weird pd file DOC: update the Index.isin docstring (pandas-dev#20249) BUG: Handle all-NA blocks in concat (pandas-dev#20382) DOC: update the pandas.core.resample.Resampler.fillna docstring (pandas-dev#20379) BUG: Don't raise exceptions splitting a blank string (pandas-dev#20067) DOC: update the pandas.DataFrame.cummax docstring (pandas-dev#20336) DOC: update the pandas.core.window.x.mean docstring (pandas-dev#20265) DOC: update the api.types.is_number docstring (pandas-dev#20196) Fix linter (pandas-dev#20389) DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta (pandas-dev#20142) DOC: update the pandas.Series.dt.is_month_end docstring (pandas-dev#20181) DOC: update the window.Rolling.min docstring (pandas-dev#20263) ...

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta

660fbb1

cemsbr suggested changes Mar 10, 2018

View reviewed changes

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta

2aa395b

jreback requested changes Mar 10, 2018

View reviewed changes

jreback added Docs Timedelta Timedelta data type labels Mar 10, 2018

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta

18d67b6

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta

c490ef4

cemsbr approved these changes Mar 10, 2018

View reviewed changes

Update accessors.py

48ca62c

jorisvandenbossche approved these changes Mar 17, 2018

View reviewed changes

jorisvandenbossche merged commit 9dc49d3 into pandas-dev:master Mar 17, 2018

jorisvandenbossche added this to the 0.23.0 milestone Mar 17, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta #20142

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta #20142

ijmbarr commented Mar 10, 2018

cemsbr Mar 10, 2018

ijmbarr Mar 10, 2018

cemsbr Mar 10, 2018

ijmbarr Mar 10, 2018

jreback Mar 10, 2018

ijmbarr Mar 10, 2018

jreback Mar 10, 2018

ijmbarr Mar 10, 2018

pep8speaks commented Mar 10, 2018 •

edited

Loading

jorisvandenbossche left a comment

codecov bot commented Mar 17, 2018

jorisvandenbossche commented Mar 17, 2018

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta #20142

DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta #20142

Conversation

ijmbarr commented Mar 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pep8speaks commented Mar 10, 2018 • edited Loading

Comment last updated on March 17, 2018 at 12:09 Hours UTC

jorisvandenbossche left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 17, 2018

Codecov Report

jorisvandenbossche commented Mar 17, 2018

pep8speaks commented Mar 10, 2018 •

edited

Loading