DOC: Improve truncate docstring (#17763) #17925
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
Contributor
reidy-p
commented
Oct 19, 2017
reidy-p
commented
- closes DateFrame.truncate is not equivalent to slicing as mentioned in docs #17763
Codecov Report
@@ Coverage Diff @@
## master #17925 +/- ##
==========================================
- Coverage 91.23% 91.22% -0.02%
==========================================
Files 163 163
Lines 50112 50113 +1
==========================================
- Hits 45722 45714 -8
- Misses 4390 4399 +9
Continue to review full report at Codecov.
|
doc/source/timeseries.rst
Outdated
|
|
||
| .. ipython:: python | ||
|
|
||
| ts.truncate(before='10/31/2011', after='12/31/2011') | ||
| ts.truncate(before='2011', after='2012') |
There was a problem hiding this comment.
maybe add the equivalent slicing example as well to show it is not the same ?
pandas/core/generic.py
Outdated
| axis : {0 or 'index', 1 or 'columns'} | ||
| * 0 or 'index': apply truncation to rows | ||
| * 1 or 'columns': apply truncation to columns | ||
| Default is stat axis for given data type (0 for Series and |
There was a problem hiding this comment.
blank line above this one
pandas/core/generic.py
Outdated
| date component in a ``DatetimeIndex`` in contrast to slicing which | ||
| returns any partially matching dates. | ||
|
|
||
| >>> dates = pd.date_range('2016-1-1', '2016-2-1', freq='s') |
There was a problem hiding this comment.
nitpick: I prefer to use iso dates in our docs (apart for examples specifically on date string parsing), so "2016-01-01" etc
|
thanks @reidy-p |
peterpanmj
pushed a commit
to peterpanmj/pandas
that referenced
this pull request
Oct 31, 2017
alanbato
pushed a commit
to alanbato/pandas
that referenced
this pull request
Nov 10, 2017
No-Stream
pushed a commit
to No-Stream/pandas
that referenced
this pull request
Nov 28, 2017
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.