BUG: DataFrame.clip arguments were inconsistent to numpy and Series.clip, closes GH pandas-dev#2747

Author: jreback

RELEASE.rst

@@ -22,6 +22,12 @@ Where to get it
 * Binary installers on PyPI: http://pypi.python.org/pypi/pandas
 * Documentation: http://pandas.pydata.org
 
+**API Changes**
+
+  - arguments to DataFrame.clip were inconsistent to numpy and Series clipping (GH2747_)
+
+.. _GH2747: https://github.com/pydata/pandas/issues/2747
+
 pandas 0.10.1
 =============
 

pandas/core/frame.py

@@ -5029,7 +5029,7 @@ def f(arr):
         data = self._get_numeric_data() if numeric_only else self
         return data.apply(f, axis=axis)
 
-    def clip(self, upper=None, lower=None):
+    def clip(self, lower=None, upper=None):
         """
         Trim values at input threshold(s)
 

pandas/tests/test_frame.py

@@ -6470,6 +6470,21 @@ def test_clip(self):
         double = self.frame.clip(upper=median, lower=median)
         self.assert_(not (double.values != median).any())
 
+    def test_dataframe_clip(self):
+
+        lb = -1
+        ub =  1
+
+        # GH #2747
+        df = DataFrame(np.random.randn(1000,2))
+        lb_mask = df.values <= lb
+        ub_mask = df.values >= ub
+        mask = ~lb_mask & ~ub_mask
+        clipped_df = df.clip(lb, ub)
+        self.assert_((clipped_df.values[lb_mask] == lb).all() == True)
+        self.assert_((clipped_df.values[ub_mask] == ub).all() == True)
+        self.assert_((clipped_df.values[mask] == df.values[mask]).all() == True)
+        
     def test_get_X_columns(self):
         # numeric and object columns