DOC: Update the pandas.DatetimeIndex docstring #32360
Merged
Conversation
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
ShaharNaveh
reviewed
Feb 29, 2020
pandas/core/indexes/datetimes.py
Outdated
| normalize : bool, default False | ||
| Normalize start/end dates to midnight before generating date range. | ||
| closed : {None, 'left', 'right'}, optional | ||
| Make the interval closed with respect to the given frequency to |
There was a problem hiding this comment.
I think that you can remove the None here, since we are saying that this parameter is optional.
Hori75
force-pushed
the
DatetimeIndex
branch
2 times, most recently
from
3ba0f76 to
a2ae6f4
Compare
Hori75
force-pushed
the
DatetimeIndex
branch
from
a2ae6f4 to
ebc0193
Compare
WillAyd
approved these changes
Feb 29, 2020
pandas/core/indexes/datetimes.py
Outdated
| Immutable ndarray of datetime64 data, represented internally as int64, and | ||
| which can be boxed to Timestamp objects that are subclasses of datetime and | ||
| carry metadata such as frequency information. | ||
| Immutable ndarray of datetime64 data. |
There was a problem hiding this comment.
not actually an ndarray anymore. maybe "ndarray-like"?
| carry metadata such as frequency information. | ||
| Immutable ndarray of datetime64 data. | ||
|
|
||
| Represented internally as int64, and which can be boxed to Timestamp objects |
There was a problem hiding this comment.
its a stretch to say "represented internally as int64" is accurate.
mentioning that DTI has freq is good, but id rather avoid mentioning it for Timestamp.
pandas/core/indexes/datetimes.py
Outdated
| freq : str or pandas offset object, optional | ||
| 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. | ||
| tz : pytz.timezone or dateutil.tz.tzfile | ||
| Timezone of the datetime. |
There was a problem hiding this comment.
we also support stdlib tzinfos, and you can pass strings that can be parsed to timezones
| Timezone of the datetime. | ||
| normalize : bool, default False | ||
| Normalize start/end dates to midnight before generating date range. | ||
| closed : {'left', 'right'}, optional |
There was a problem hiding this comment.
should "both:" be in here?
There was a problem hiding this comment.
can we avoid the word "interval" below? dont want ambiguity with IntervalIndex
There was a problem hiding this comment.
I think None means both.
pandas/core/indexes/datetimes.py
Outdated
| dayfirst : bool, default False | ||
| If True, parse dates in `data` with the day first order. | ||
| yearfirst : bool, default False | ||
| If True parse dates in `data` with the year first order. | ||
| dtype : numpy.dtype or DatetimeTZDtype |
pandas/core/indexes/datetimes.py
Outdated
| dayfirst : bool, default False | ||
| If True, parse dates in `data` with the day first order. | ||
| yearfirst : bool, default False | ||
| If True parse dates in `data` with the year first order. | ||
| dtype : numpy.dtype or DatetimeTZDtype | ||
| Note that the only NumPy dtype allowed is ‘datetime64[ns]’. | ||
| copy : bool |
pandas/core/indexes/datetimes.py
Outdated
| Note that the only NumPy dtype allowed is ‘datetime64[ns]’. | ||
| copy : bool | ||
| Make a copy of input ndarray. | ||
| name : object |
|
Thanks for the improvements to this docstring @Hori75 |
SeeminSyed
pushed a commit
to CSCD01-team01/pandas
that referenced
this pull request
Mar 22, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diffOutput of
python scripts/validate_docstrings.py pandas.DatetimeIndex