-
-
Notifications
You must be signed in to change notification settings - Fork 17.9k
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
DOC: Fix Order of parameters in docstrings #23611
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
731d27e
correct orders
thoo c0e5c7f
Merge remote-tracking branch 'upstream/master' into order_of_parameter
thoo 954d90c
drop to_html and to_string
thoo 84e5ba7
Merge remote-tracking branch 'upstream/master' into order_of_parameter
thoo 5d7c5ce
Change boolean,string to bool,str
thoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -807,15 +807,15 @@ class CustomBusinessDay(_CustomMixin, BusinessDay): | |
Parameters | ||
---------- | ||
n : int, default 1 | ||
offset : timedelta, default timedelta(0) | ||
normalize : bool, default False | ||
Normalize start/end dates to midnight before generating date range | ||
weekmask : str, Default 'Mon Tue Wed Thu Fri' | ||
weekmask of valid business days, passed to ``numpy.busdaycalendar`` | ||
holidays : list | ||
list/array of dates to exclude from the set of valid business days, | ||
passed to ``numpy.busdaycalendar`` | ||
calendar : pd.HolidayCalendar or np.busdaycalendar | ||
calendar : pd.HolidayCalendar or np. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. looks like There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry ! |
||
offset : timedelta, default timedelta(0) | ||
""" | ||
_prefix = 'C' | ||
_attributes = frozenset(['n', 'normalize', | ||
|
@@ -958,7 +958,6 @@ class _CustomBusinessMonth(_CustomMixin, BusinessMixin, MonthOffset): | |
Parameters | ||
---------- | ||
n : int, default 1 | ||
offset : timedelta, default timedelta(0) | ||
normalize : bool, default False | ||
Normalize start/end dates to midnight before generating date range | ||
weekmask : str, Default 'Mon Tue Wed Thu Fri' | ||
|
@@ -967,6 +966,7 @@ class _CustomBusinessMonth(_CustomMixin, BusinessMixin, MonthOffset): | |
list/array of dates to exclude from the set of valid business days, | ||
passed to ``numpy.busdaycalendar`` | ||
calendar : pd.HolidayCalendar or np.busdaycalendar | ||
offset : timedelta, default timedelta(0) | ||
""" | ||
_attributes = frozenset(['n', 'normalize', | ||
'weekmask', 'holidays', 'calendar', 'offset']) | ||
|
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when specifying parameter types: string --> str (a couple other instances of this elsewhere too)