DOC: update the pandas.Series.dt.is_leap_year docstring #20150
Conversation
pandas/core/indexes/datetimes.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| is_leap_year : Series of boolean |
There was a problem hiding this comment.
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.
pandas/core/indexes/datetimes.py
Outdated
| """ | ||
| 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 |
There was a problem hiding this comment.
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."
pandas/core/indexes/datetimes.py
Outdated
| Examples | ||
| -------- | ||
| >>> import pandas as pd | ||
| >>> dates = pd.date_range("2012-01-01", "2015-01-01", freq="Y") |
There was a problem hiding this comment.
no need to import pandas or numpy
Codecov Report
@@ Coverage Diff @@
## master #20150 +/- ##
==========================================
- Coverage 91.8% 91.72% -0.08%
==========================================
Files 152 150 -2
Lines 49206 49152 -54
==========================================
- Hits 45172 45086 -86
- Misses 4034 4066 +32
Continue to review full report at Codecov.
|
|
Thanks all! |
Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):
scripts/validate_docstrings.py <your-function-or-method>git diff upstream/master -u -- "*.py" | flake8 --diffpython doc/make.py --single <your-function-or-method>Please include the output of the validation script below between the "```" ticks:
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.
See Also is not relevant for this function as there is no other leap year related functions.