DOC: Updated docstrings related to DateTimeIndex. GH22459 #22504
Conversation
Codecov Report
@@ Coverage Diff @@
## master #22504 +/- ##
==========================================
+ Coverage 92.22% 92.23% +<.01%
==========================================
Files 161 161
Lines 51187 51197 +10
==========================================
+ Hits 47209 47220 +11
+ Misses 3978 3977 -1
Continue to review full report at Codecov.
|
| >>> pd.bdate_range(start='1/1/2018', end='1/08/2018') | ||
| DatetimeIndex(['2018-01-01', '2018-01-02', '2018-01-03', '2018-01-04', | ||
| '2018-01-05', '2018-01-08'], | ||
| dtype='datetime64[ns]', freq='B') |
There was a problem hiding this comment.
Hmmm...that output formatting of the lines is a little weird there. Should they be more aligned?
| the 'left', 'right', or both sides (None) | ||
| the 'left', 'right', or both sides (None). | ||
| **kwargs | ||
| For compatibility. Has no effect on the result. |
There was a problem hiding this comment.
Not sure we need to document **kwargs?
There was a problem hiding this comment.
Yes, we've been documenting them, even when we need to say that they don't have any effect. Explicit is better than implicit. :)
|
Hello @eldritchideen! Thanks for updating the PR.
|
|
@eldritchideen : Can you rebase onto |
|
@eldritchideen Can you please merge master into your PR? This will rerun the CI checks, and when everything is green we can merge this. |
|
Rebased, merging on green. |
|
thanks @eldritchideen |
git diff upstream/master -u -- "*.py" | flake8 --diffUpdated
pandas.date_rangeandpandas.bdate_rangedocstrings to resolve errors raised fromscripts/validate_docstrings.pyfrom #22459. Also added an example topandas.bdate_range.