Skip to content

DOC: update examples in MonthBegin/MonthEnd to use rollbackward/rollforward #52161

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

Merged
merged 2 commits into from
Mar 24, 2023

Conversation

pranav-ravuri
Copy link
Contributor

################################################################################
#################### Docstring (pandas.offsets.MonthBegin)  ####################
################################################################################

DateOffset of one month at beginning.

Examples
--------
>>> ts = pd.Timestamp(2022, 1, 1)
>>> ts + pd.offsets.MonthBegin()
Timestamp('2022-02-01 00:00:00')

################################################################################
################################## Validation ##################################
################################################################################

2 Errors found:
        No extended summary found
        See Also section not found

- updated docstrings of pandas.offsers.MonthBegin, MonthEnd, BMonthBegin, BMonthEnd
@mroeschke mroeschke added Docs Frequency DateOffsets labels Mar 24, 2023
@mroeschke mroeschke requested a review from MarcoGorelli March 24, 2023 16:58
@MarcoGorelli MarcoGorelli added this to the 2.0 milestone Mar 24, 2023
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

This is a great first contribution, thanks @pranav-ravuri ! Looks good to me pending green

@MarcoGorelli MarcoGorelli merged commit 4bf60ac into pandas-dev:main Mar 24, 2023
@lumberbot-app
Copy link

lumberbot-app bot commented Mar 24, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 2.0.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 4bf60ac2bab5878c1a0f640ab826df77a77f7e98
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #52161: Docs/update issue 52106'
  1. Push to a named branch:
git push YOURFORK 2.0.x:auto-backport-of-pr-52161-on-2.0.x
  1. Create a PR against branch 2.0.x, I would have named this PR:

"Backport PR #52161 on branch 2.0.x (Docs/update issue 52106)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@MarcoGorelli MarcoGorelli changed the title Docs/update issue 52106 DOC: update examples in MonthBegin/MonthEnd to use rollbackward/rollforward Mar 24, 2023
MarcoGorelli pushed a commit to MarcoGorelli/pandas that referenced this pull request Mar 24, 2023
@MarcoGorelli
Copy link
Member

@pranav-ravuri there's one more related one, in case you wanted to take this one on #52169

MarcoGorelli pushed a commit to MarcoGorelli/pandas that referenced this pull request Mar 24, 2023
@pranav-ravuri
Copy link
Contributor Author

Hi @MarcoGorelli there seems to be conflict, but I did not understand what it is? And how could I have avoided it?

@MarcoGorelli
Copy link
Member

the conflict is only when backporting to version 2.0 (from which the next stable docs will be built) - you did everything right, it's just that not everything gets backported, so conflicts creep in sometimes

mroeschke pushed a commit that referenced this pull request Mar 24, 2023
Backport PR #52161: Docs/update issue 52106

Co-authored-by: Pranav Saibhushan Ravuri <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: MonthBegin suggestion to get start of current month not quite right?
4 participants