Skip to content

DOC: update the pandas.Series.dt.is_leap_year docstring #20150

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

Merged
merged 6 commits into from
Mar 17, 2018
+37 −1
Merged

DOC: update the pandas.Series.dt.is_leap_year docstring #20150

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
054ac69
adding docstring to pandas.Series.dt.is_leap_year
rok Mar 10, 2018
f585cca
Merge remote-tracking branch 'upstream/master' into series_dt_month
rok Mar 10, 2018
e32f613
Merge remote-tracking branch 'upstream/master' into series_dt_month
rok Mar 10, 2018
605fd20
correcting docstring
rok Mar 10, 2018
8615d93
Merge remote-tracking branch 'upstream/master' into rok-series_dt_month
jorisvandenbossche Mar 17, 2018
132c335
make generic for index/series
jorisvandenbossche Mar 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion pandas/core/indexes/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1753,7 +1753,32 @@ def freq(self, value):
is_leap_year = _field_accessor(
'is_leap_year',
'is_leap_year',
"Logical indicating if the date belongs to a leap year")
"""
Return a boolean indicating if the date belongs to a leap year.

A leap year is a year, occurring every four years, which has 366 days
Copy link
Contributor

Choose a reason for hiding this comment

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

There are exceptions for this four year rule, years divisible by 100 are not leap years except if they are also divisible by 400.
From wiki:
"Every year that is exactly divisible by four is a leap year, except for years that are exactly divisible by 100, but these centurial years are leap years if they are exactly divisible by 400. For example, the years 1700, 1800, and 1900 were not leap years, but the years 1600 and 2000 were."

(instead of 365) including 29th of February as an intercalary day.

Returns
-------
is_leap_year : Series of boolean
Copy link
Contributor

Choose a reason for hiding this comment

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

There's no need to name the return value, only it's type. And it's missing the description.

The documentation of the return is also similar to the parameters. But in this case, no name will be provided, unless the method returns or yields more than one value (a tuple of values).

The parameters are defined by their name, followed by a space, a colon, another space, and the type (or types). Note that the space between the name and the colon is important. Types are not defined for *args and **kwargs, but must be defined for all other parameters. After the parameter definition, it is required to have a line with the parameter description, which is indented, and can have multiple lines. The description must start with a capital letter, and finish with a dot.


Examples
--------
>>> import pandas as pd
>>> dates = pd.date_range("2012-01-01", "2015-01-01", freq="Y")
Copy link
Contributor

Choose a reason for hiding this comment

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

no need to import pandas or numpy

>>> dates_series = pd.Series(dates)
>>> dates_series
0 2012-12-31
1 2013-12-31
2 2014-12-31
dtype: datetime64[ns]
>>> dates_series.dt.is_leap_year
0 True
1 False
2 False
dtype: bool
""")

@property
def time(self):
Expand Down