DOC: update the pandas.DateTimeArrayMixin.is_month_start docstring

[CalmDownKarm]

• closes DOC: update the pandas.Series.dt.is_month_start docstring #20146
• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry
  should close PR DOC: update the pandas.Series.dt.is_month_start docstring #20146

[pep8speaks]

Hello @CalmDownKarm! Thanks for updating the PR.

• There are no PEP8 issues in the file pandas/core/arrays/datetimes.py !

Comment last updated on October 11, 2018 at 07:18 Hours UTC

[codecov]

Codecov Report

Merging #23051 into master will increase coverage by 0.03%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #23051      +/-   ##
==========================================
+ Coverage   92.19%   92.22%   +0.03%     
==========================================
  Files         169      169              
  Lines       50954    51259     +305     
==========================================
+ Hits        46975    47275     +300     
- Misses       3979     3984       +5

Flag	Coverage Δ
#multiple	90.66% <100%> (+0.05%)	⬆️
#single	42.23% <100%> (-0.04%)	⬇️

Impacted Files	Coverage Δ
pandas/core/arrays/datetimes.py	97.46% <100%> (+0.08%)	⬆️
pandas/io/feather_format.py	77.14% <0%> (-8.58%)	⬇️
pandas/core/arrays/datetimelike.py	93.21% <0%> (-1.69%)	⬇️
pandas/core/dtypes/concat.py	96.34% <0%> (-1.35%)	⬇️
pandas/core/indexes/period.py	92.27% <0%> (-0.98%)	⬇️
pandas/core/arrays/sparse.py	91.84% <0%> (-0.71%)	⬇️
pandas/core/arrays/categorical.py	95.21% <0%> (-0.41%)	⬇️
pandas/core/ops.py	94.24% <0%> (-0.4%)	⬇️
pandas/io/common.py	70.76% <0%> (-0.28%)	⬇️
pandas/core/dtypes/common.py	94.86% <0%> (-0.25%)	⬇️
... and 55 more

---

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 9285820...9e0f242. Read the comment docs.

[datapythonista]

There are few formatting problems. There are two things you should do:

• Validate the docstring for formatting errors: ./scripts/validate_docstrings.py pandas.DateTimeArrayMixin.is_month_start
• Generate the html and see if it renders correctly: ./doc/make.py html --single=pandas.DateTimeArrayMixin.is_month_start

[CalmDownKarm]

@datapythonista I made the changes you asked for, but both commands you asked me to run failed - AttributeError: module 'pandas' has no attribute 'DateTimeArrayMixin' probably a broken setup on my end?

[datapythonista]

The command to run is ./scripts/validate_docstrings.py pandas.core.arrays.datetimes.DateTimeArrayMising.

Got the full path to the class from the PR title, but seems like it's been shortened there.

[datapythonista]

is the validation script happy now?

[datapythonista]

seems like there are whitespaces at the end of some lines in your code (check travis), can you remove them and validate pep8

[CalmDownKarm]

@datapythonista fixed flake8 and validation script works now, but I'm unable to generate the html.

python scripts/validate_docstrings.py pandas.core.arrays.datetimes.DatetimeArrayMixin.is_month_start
validates fine
but if I run
python doc/make.py html --single=pandas.core.arrays.datetimes.DatetimeArrayMixin.is_month_start
I get
AttributeError: module 'pandas.core.arrays' has no attribute 'datetimes'

[datapythonista]

lgtm

I didn't realize before, but probably it makes sense to have a common template for is_month_start and is_month_end, but we can take care of that in a separate PR.

@jbrockmendel do you want to take a look and merge if you're happy

[datapythonista]

lgtm, thanks!

[datapythonista]

lgtm, thanks!

[jorisvandenbossche]

Thanks @CalmDownKarm !