docs(arrow): add complete list of accepted kwargs to shift() docstring#1307
Open
koteshyelamati wants to merge 1 commit into
Open
docs(arrow): add complete list of accepted kwargs to shift() docstring#1307koteshyelamati wants to merge 1 commit into
koteshyelamati wants to merge 1 commit into
Conversation
Addresses arrow-py#1287: the shift() docstring now explicitly lists all accepted keyword arguments: years, months, weeks, days, hours, minutes, seconds, microseconds, quarters, weekday. Each param is documented with its type/description using Sphinx :param: format.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1307 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 10 10
Lines 2315 2315
Branches 358 358
=========================================
Hits 2315 2315 ☔ View full report in Codecov by Harness. |
jonathan-s
approved these changes
Jul 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #1287: the shift() docstring now explicitly lists all accepted keyword arguments: years, months, weeks, days, hours, minutes, seconds, microseconds, quarters, weekday. Each param is documented with its type/description using Sphinx :param: format.
Pull Request Checklist
Thank you for taking the time to improve Arrow! Before submitting your pull request, please check all appropriate boxes:
toxormake testto find out!).tox -e lintormake lintto find out!).masterbranch.If you have any questions about your code changes or any of the points above, please submit your questions along with the pull request and we will try our best to help!
Description of Changes