From 362a9929c31fb08df8ba0ba3e22fae8830bd05ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dra=C5=BEen=20Lu=C4=8Danin?= Date: Mon, 18 Mar 2013 21:29:48 +0100 Subject: [PATCH 1/2] Resample docstring default values changed This docstring seems better, since TimeGrouper specifies it [that way][1] too: [1]: https://github.com/pydata/pandas/blob/master/pandas/tseries/resample.py#L27 --- pandas/core/generic.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 2c5c8c4d088be..10c67d6d78ed5 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -231,9 +231,9 @@ def resample(self, rule, how=None, axis=0, fill_method=None, downsampling axis : int, optional, default 0 fill_method : string, fill_method for upsampling, default None - closed : {'right', 'left'}, default None + closed : {'right', 'left'}, default 'left' Which side of bin interval is closed - label : {'right', 'left'}, default None + label : {'right', 'left'}, default 'left' Which bin edge label to label bucket with convention : {'start', 'end', 's', 'e'} kind: "period"/"timestamp" From 5b5973fcece938782da45f1d4f8b5c70b7f25c6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Draz=CC=8Cen=20Luc=CC=8Canin?= Date: Wed, 20 Mar 2013 11:01:47 +0100 Subject: [PATCH 2/2] Remove confusing default val hints from docstrings --- pandas/core/generic.py | 4 ++-- pandas/tseries/resample.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 10c67d6d78ed5..970c345d04194 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -231,9 +231,9 @@ def resample(self, rule, how=None, axis=0, fill_method=None, downsampling axis : int, optional, default 0 fill_method : string, fill_method for upsampling, default None - closed : {'right', 'left'}, default 'left' + closed : {'right', 'left'} Which side of bin interval is closed - label : {'right', 'left'}, default 'left' + label : {'right', 'left'} Which bin edge label to label bucket with convention : {'start', 'end', 's', 'e'} kind: "period"/"timestamp" diff --git a/pandas/tseries/resample.py b/pandas/tseries/resample.py index fbfbbc7ccdd13..b20303efe222f 100644 --- a/pandas/tseries/resample.py +++ b/pandas/tseries/resample.py @@ -24,8 +24,8 @@ class TimeGrouper(CustomGrouper): Parameters ---------- freq : pandas date offset or offset alias for identifying bin edges - closed : closed end of interval; left (default) or right - label : interval boundary to use for labeling; left (default) or right + closed : closed end of interval; left or right + label : interval boundary to use for labeling; left or right nperiods : optional, integer convention : {'start', 'end', 'e', 's'} If axis is PeriodIndex