DOC: add closed and dtype in TimedeltaIndex parameters #49167
Conversation
MarceloCMiguel
commented
Oct 18, 2022
•
MarceloCMiguel
commented
- closes DOC: closed and dtype missing from TimedeltaIndex docs #49153
- All code checks passed.
MarceloCMiguel
changed the title
MarceloCMiguel
changed the title
| @@ -60,6 +60,11 @@ class TimedeltaIndex(DatetimeTimedeltaMixin): | |||
| One of pandas date offset strings or corresponding objects. The string | |||
| 'infer' can be passed in order to set the frequency of the index as the | |||
| inferred frequency upon creation. | |||
| closed : str, default None | |||
There was a problem hiding this comment.
@jbrockmendel should the TimedeltaIndex constructor accept closed? It appears not to do anything with the argument
There was a problem hiding this comment.
Same was noticed in pandas-stubs by @Dr-Irv. We thought deprecation or just removal made the most sense.
There was a problem hiding this comment.
Should I remove the closed parameter then?
There was a problem hiding this comment.
Ideally remove and deprecate closed using @deprecate_kwarg
There was a problem hiding this comment.
I tried to find some other function that uses @depreceate_kwarg but couldn't find any, would it be something like this?
@deprecate_kwarg
closed : str, default None
Make the interval closed with respect to the given frequency to
the 'left', 'right', or both sides (None).
There was a problem hiding this comment.
You can reference the @deprecate_kwarg usage from this older PR: #47912
|
This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this. |
|
Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen. |
