-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: update the pandas.Series.dt.is_month_start docstring #20146
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.
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
Conversation
Hello @janelle! Thanks for updating the PR.
Comment last updated on March 10, 2018 at 15:01 Hours UTC |
pandas/core/indexes/datetimes.py
Outdated
Examples | ||
-------- | ||
>>> import pandas as pd | ||
>>> dates = pd.Series(pd.date_range("2018-02-27", periods = 3)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PEP8 doesn't allow spaces around keyword parameters. i.e.: periods=3
, instead of periods = 3
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
import pandas as pd
is not necessary.
pandas/core/indexes/datetimes.py
Outdated
@@ -1736,12 +1736,12 @@ def freq(self, value): | |||
|
|||
See Also | |||
-------- | |||
is_month_end : Returns a boolean indicating if the date is the last day of the month. | |||
is_month_end : Returns a boolean indicating if the date is the last day | |||
of the month. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Next line should be indented:
is_month_end : Returns a boolean indicating if the date is the last day
of the month.
thanks for reviewing, adjusted line lengths and writing style now. |
@arnau126 adjusted line lengths and writing style |
This PR is perhaps no longer relevant, the _field_accessor(...) transform was replaced by the _wrap_field_accessor(name) in this commit @datapythonista |
@CalmDownKarm the function has been moved here: I think the best would be to start a fresh branch from master, and copy the code from the docstring in this PR to that location. CC: @jbrockmendel |
Discontinued and superseded by #23051 |
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 --diff
python 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.
This function does not require an extended summary. Peers find it very clear with a short summary too.