DOC: Update the DatetimeIndex.normalize docstring #20094

techytushar · 2018-03-10T04:34:11Z

Signed-off-by: Tushar Mittal chiragmittal.mittal@gmail.com

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

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.DatetimeIndex.normalize) ##################
################################################################################

Return DatetimeIndex with times converted to midnight.

When using DatetimeIndex, the time can be converted to midnight i.e.
00:00:00. This is useful in cases, when the time does not matter.
Length is unaltered. The timezones are unaffected. If the frequency
is 'H','min' or 'S' it changes to None otherwise it remains 
unaffected.

Returns
-------
normalized : DatetimeIndex

See Also
--------
DatetimeIndex.floor : Floor the DatetimeIndex to the specified freq.
DatetimeIndex.ceil : Ceil the DatetimeIndex to the specified freq.
DatetimeIndex.round : Round the DatetimeIndex to the specified freq.

Examples
--------
>>> df = pd.DatetimeIndex(start='2014-08-01 10:00', freq='H',
...                       periods=3, tz='Asia/Calcutta')
>>> df
DatetimeIndex(['2014-08-01 10:00:00+05:30',
               '2014-08-01 11:00:00+05:30',
               '2014-08-01 12:00:00+05:30'],
                dtype='datetime64[ns, Asia/Calcutta]', freq='H')
>>> df.normalize()
DatetimeIndex(['2014-08-01 00:00:00+05:30',
               '2014-08-01 00:00:00+05:30',
               '2014-08-01 00:00:00+05:30'],
               dtype='datetime64[ns, Asia/Calcutta]', freq=None)

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

Docstring for "pandas.DatetimeIndex.normalize" correct. :)

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.

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

IHackPy

LGTM

codecov · 2018-03-10T11:01:36Z

Codecov Report

❗ No coverage uploaded for pull request base (master@72eafde). Click here to learn what that means.
The diff coverage is 100%.

@@            Coverage Diff            @@
##             master   #20094   +/-   ##
=========================================
  Coverage          ?    91.7%           
=========================================
  Files             ?      150           
  Lines             ?    49152           
  Branches          ?        0           
=========================================
  Hits              ?    45074           
  Misses            ?     4078           
  Partials          ?        0

Flag	Coverage Δ
#multiple	`90.08% <100%> (?)`
#single	`41.84% <100%> (?)`

Impacted Files	Coverage Δ
pandas/core/indexes/datetimes.py	`95.64% <100%> (ø)`

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 72eafde...84aab8e. Read the comment docs.

jreback · 2018-03-10T13:06:08Z

pandas/core/indexes/datetimes.py

+        Return DatetimeIndex with times converted to midnight.
+
+        When using DatetimeIndex, the time can be converted to midnight i.e.
+        00:00:00. This is useful in cases, when the time does not matter in


This useful in cases where the time does not matter (remove the in DataFrame). The length of the DatetimeIndex is unaltered.

maybe mention this does not affect tz's

jreback · 2018-03-10T13:06:56Z

pandas/core/indexes/datetimes.py

+        Examples
+        --------
+        >>> df = pd.DataFrame({'date':['2015-05-01 18:47:05.060000',
+        ...                            '2014-05-01 18:47:05.110000']})


can you add another example with a tz.

jreback · 2018-03-10T13:07:12Z

pandas/core/indexes/datetimes.py

+        Return DatetimeIndex with times converted to midnight.
+
+        When using DatetimeIndex, the time can be converted to midnight i.e.
+        00:00:00. This is useful in cases, when the time does not matter in


maybe mention this does not affect tz's

techytushar · 2018-03-10T13:47:32Z

@jreback required changes done, please review 😀

jreback

small changes, otherwise lgtm.

jreback · 2018-03-10T14:29:38Z

pandas/core/indexes/datetimes.py

+
+        When using DatetimeIndex, the time can be converted to midnight i.e.
+        00:00:00. This is useful in cases, when the time does not matter.
+        Length is unaltered. The timezones are unaffected. If the frequency


I would remove the last sentence. freq is actually re-inferred here, so this is misleading.

marielen · 2018-03-10T14:33:04Z

pandas/core/indexes/datetimes.py

@@ -1770,11 +1770,38 @@ def date(self):

    def normalize(self):
        """
-        Return DatetimeIndex with times to midnight. Length is unaltered
+        Return DatetimeIndex with times converted to midnight.


Please, make a simpler description. I suggest Convert times to midnight.

Signed-off-by: Tushar Mittal <chiragmittal.mittal@gmail.com>

techytushar · 2018-03-10T14:40:14Z

done!

…ring

jorisvandenbossche

Looks good!

I made a few edits to make it more generic for both DatetimeIndex and Series.dt (they share the docstring)

techytushar changed the title ~~Update the DatetimeIndex.normalize docstring~~ Doc: Update the DatetimeIndex.normalize docstring Mar 10, 2018

IHackPy approved these changes Mar 10, 2018

View reviewed changes

jreback changed the title ~~Doc: Update the DatetimeIndex.normalize docstring~~ DOC: Update the DatetimeIndex.normalize docstring Mar 10, 2018

jreback added Docs Datetime Datetime data dtype labels Mar 10, 2018

jreback requested changes Mar 10, 2018

View reviewed changes

techytushar force-pushed the docstring branch from 3da2bdb to 5613547 Compare March 10, 2018 13:46

techytushar force-pushed the docstring branch from 5613547 to ccf4fbb Compare March 10, 2018 14:22

jreback requested changes Mar 10, 2018

View reviewed changes

marielen suggested changes Mar 10, 2018

View reviewed changes

Add docstring for DatetimeIndex.normalize method

05b17f5

Signed-off-by: Tushar Mittal <chiragmittal.mittal@gmail.com>

techytushar force-pushed the docstring branch from ccf4fbb to 05b17f5 Compare March 10, 2018 14:39

jreback approved these changes Mar 10, 2018

View reviewed changes

jreback added this to the 0.23.0 milestone Mar 10, 2018

jorisvandenbossche added 2 commits March 15, 2018 15:21

Merge remote-tracking branch 'upstream/master' into techytushar-docst…

62a0455

…ring

make generic for index and series

84aab8e

jorisvandenbossche force-pushed the docstring branch from 0c0df1b to 84aab8e Compare March 15, 2018 14:27

jorisvandenbossche approved these changes Mar 15, 2018

View reviewed changes

jorisvandenbossche merged commit 6ccd6c1 into pandas-dev:master Mar 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

DOC: Update the DatetimeIndex.normalize docstring #20094

DOC: Update the DatetimeIndex.normalize docstring #20094

Uh oh!

techytushar commented Mar 10, 2018 •

edited

Loading

Uh oh!

IHackPy left a comment

Uh oh!

codecov bot commented Mar 10, 2018 •

edited

Loading

Uh oh!

jreback Mar 10, 2018

Uh oh!

jreback Mar 10, 2018

Uh oh!

jreback Mar 10, 2018

Uh oh!

jreback Mar 10, 2018

Uh oh!

techytushar commented Mar 10, 2018

Uh oh!

jreback left a comment

Uh oh!

jreback Mar 10, 2018

Uh oh!

marielen Mar 10, 2018

Uh oh!

techytushar commented Mar 10, 2018

Uh oh!

jorisvandenbossche left a comment

Uh oh!

Uh oh!

Uh oh!

DOC: Update the DatetimeIndex.normalize docstring #20094

DOC: Update the DatetimeIndex.normalize docstring #20094

Uh oh!

Conversation

techytushar commented Mar 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IHackPy left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jreback Mar 10, 2018

Choose a reason for hiding this comment

Uh oh!

jreback Mar 10, 2018

Choose a reason for hiding this comment

Uh oh!

jreback Mar 10, 2018

Choose a reason for hiding this comment

Uh oh!

jreback Mar 10, 2018

Choose a reason for hiding this comment

Uh oh!

techytushar commented Mar 10, 2018

Uh oh!

jreback left a comment

Choose a reason for hiding this comment

Uh oh!

jreback Mar 10, 2018

Choose a reason for hiding this comment

Uh oh!

marielen Mar 10, 2018

Choose a reason for hiding this comment

Uh oh!

techytushar commented Mar 10, 2018

Uh oh!

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

techytushar commented Mar 10, 2018 •

edited

Loading

codecov bot commented Mar 10, 2018 •

edited

Loading