48779-doc-MonthEnd

[natmokval]

• closes BUG: pd.offsets.MonthEnd() delevers wrong month #48779
• All code checks passed.
  As proposed by @MarcoGorelli I updated docs for MonthEnd and added one more example to highlight “the last day of the month” behavior.

I checked that build of documentation shows the new description.

[MarcoGorelli]

Nice, thanks for working on this!

First, can you check the docstring guide please https://pandas.pydata.org/docs/development/contributing_docstring.html ? Looks like there's a docstring validation error https://github.com/pandas-dev/pandas/actions/runs/3572834601/jobs/6006181203

It might also be good to have an example which uses n=0?

[natmokval]

Thank you @MarcoGorelli, for your comments and hints. I corrected my docstring and added an example, which uses n=0

Unfortunately, my docker environment is broken by absence of visioner.py and I can not validate my changes locally.
If I am not mistaken, visioner.py is missing after recent commit: BLD: use nonvendor versioneer (#49924)

[MarcoGorelli]

thanks for updating!

could you try updating your environment? versioneer was added to the environment.yml file in that PR. I don't know about how it works in the Docker container, but for me mamba env update -n pandas-dev --file environment.yml worked

[WillAyd]

Assuming you are using the Dockerfile in this repo, a force rebuild of the image should pick up the versioneer dependency

[natmokval]

Assuming you are using the Dockerfile in this repo, a force rebuild of the image should pick up the versioneer dependency

Thank you @WillAyd, I fixed my problem with docker image.

[natmokval]

could you try updating your environment? versioneer was added to the environment.yml file in that PR. I don't know about how it works in the Docker container, but for me mamba env update -n pandas-dev --file environment.yml worked

Thank you, @MarcoGorelli, my environment works well now. I fixed errors in docs for MonthEnd and added an example for n=0. Docstring validation also requested me to add See Also section. I added the reference to DateOffset.

I noticed one check during CI failed, but I assume it was caused by timeout and not by my changes.

[MarcoGorelli]

Looks good, thanks @natmokval !

If there's other DateOffsets where similar confusion can arise, PRs to add examples / clarification there too would be welcome

Regarding the "see also" note - this isn't strictly necessary to pass CI, as the codes in

pandas/ci/code_checks.sh

Line 83 in 4d0a436

$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06

are currently checked - but it's nice to have it anyway, thanks!

[natmokval]

If there's other DateOffsets where similar confusion can arise, PRs to add examples / clarification there too would be welcome

Certainly. Checking other DateOffsets looks like a good idea. I will look into it.

Regarding the "see also" note - this isn't strictly necessary to pass CI, as the codes in

pandas/ci/code_checks.sh

Line 83 in 4d0a436

$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06

are currently checked - but it's nice to have it anyway, thanks!

I will use the same list of errors locally the next time.

Thank you @MarcoGorelli, for your guidance and support. It makes contributing to pandas pleasant and not too complicated.