Skip to content

DOC: update documentation for CustomBusinessHour #50182

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Dec 12, 2022
Merged

DOC: update documentation for CustomBusinessHour #50182

merged 5 commits into from
Dec 12, 2022

Conversation

natmokval
Copy link
Contributor

Updated documentation for CustomBusinessHour. Added missing parameters: holidays, calendar, and offset. Provided more examples.

MarcoGorelli
MarcoGorelli reviewed Dec 11, 2022
View reviewed changes
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.

thanks for working on this, it's already much clearer

pandas/_libs/tslibs/offsets.pyx Outdated
Comment on lines 3641 to 3642
offset : timedelta, default timedelta(0)
Time offset to apply.
Copy link
Member

Choose a reason for hiding this comment

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

have you noticed whether this parameter has any effect, or is it unused?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I haven’t checked it yet, but I’ll do it. If the parameter has any effect, I’ll add an example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My checks show that the parameter offset hasn't any effect on how the CustomBusinessHour works. That is why I don’t mark it as a parameter of CustomBusinessHour.

MarcoGorelli
MarcoGorelli reviewed Dec 12, 2022
View reviewed changes
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.

Nice! Just one more comment

CI failures are unrelated (and fixed as of #50205), if you fetch and merge upstream/main then it should be fine

@MarcoGorelli MarcoGorelli added this to the 2.0 milestone Dec 12, 2022
MarcoGorelli
MarcoGorelli approved these changes Dec 12, 2022
View reviewed changes
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.

Looks good to me - really minor, but in general it's maybe not necessary to say "In the example below", you can just state what's going to be shown. Anyway, not a blocker, this is fine as-is!

@natmokval
Copy link
Contributor Author

Thank you, MarcoGorelli, for reviewing my PR. I'll keep your comments in mind.
The cat looks cute, just a little bit sad.

@MarcoGorelli
Copy link
Member

😄 I didn't choose it, it's taken randomly from https://chriskuehl.github.io/shipit/ (though perhaps I should curate my own list)

@MarcoGorelli MarcoGorelli merged commit d27f47b into pandas-dev:main Dec 12, 2022
@natmokval natmokval mentioned this pull request Dec 13, 2022
Merged
1 task
@natmokval natmokval mentioned this pull request Mar 13, 2023
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcoGorelli MarcoGorelli MarcoGorelli approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
2.0
Development

Successfully merging this pull request may close these issues.

BUG: CustomBusinessHour is to capturing last business hour defined by end parameter
2 participants
@natmokval @MarcoGorelli