From c23482c5ba490af93e0a3e5385e7894904e77092 Mon Sep 17 00:00:00 2001 From: Andy Craze Date: Thu, 14 Dec 2017 19:55:37 -0800 Subject: [PATCH 1/2] DOC: standardizing docstrings to use pd.DataFrame closes #18770 --- pandas/core/frame.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 753c623b2de4c..e0e072965c77d 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -2304,7 +2304,7 @@ def query(self, expr, inplace=False, **kwargs): -------- >>> from numpy.random import randn >>> from pandas import DataFrame - >>> df = DataFrame(randn(10, 2), columns=list('ab')) + >>> df = pd.DataFrame(randn(10, 2), columns=list('ab')) >>> df.query('a > b') >>> df[df.a > df.b] # same result as the previous expression """ @@ -2368,7 +2368,7 @@ def eval(self, expr, inplace=False, **kwargs): -------- >>> from numpy.random import randn >>> from pandas import DataFrame - >>> df = DataFrame(randn(10, 2), columns=list('ab')) + >>> df = pd.DataFrame(randn(10, 2), columns=list('ab')) >>> df.eval('a + b') >>> df.eval('c = a + b') """ @@ -2664,7 +2664,7 @@ def assign(self, **kwargs): Examples -------- - >>> df = DataFrame({'A': range(1, 11), 'B': np.random.randn(10)}) + >>> df = pd.DataFrame({'A': range(1, 11), 'B': np.random.randn(10)}) Where the value is a callable, evaluated on `df`: @@ -3780,7 +3780,7 @@ def nlargest(self, n, columns, keep='first'): Examples -------- - >>> df = DataFrame({'a': [1, 10, 8, 11, -1], + >>> df = pd.DataFrame({'a': [1, 10, 8, 11, -1], ... 'b': list('abdce'), ... 'c': [1.0, 2.0, np.nan, 3.0, 4.0]}) >>> df.nlargest(3, 'a') @@ -3815,7 +3815,7 @@ def nsmallest(self, n, columns, keep='first'): Examples -------- - >>> df = DataFrame({'a': [1, 10, 8, 11, -1], + >>> df = pd.DataFrame({'a': [1, 10, 8, 11, -1], ... 'b': list('abdce'), ... 'c': [1.0, 2.0, np.nan, 3.0, 4.0]}) >>> df.nsmallest(3, 'a') @@ -5818,7 +5818,7 @@ def quantile(self, q=0.5, axis=0, numeric_only=True, Examples -------- - >>> df = DataFrame(np.array([[1, 1], [2, 10], [3, 100], [4, 100]]), + >>> df = pd.DataFrame(np.array([[1, 1], [2, 10], [3, 100], [4, 100]]), columns=['a', 'b']) >>> df.quantile(.1) a 1.3 @@ -5941,7 +5941,7 @@ def isin(self, values): -------- When ``values`` is a list: - >>> df = DataFrame({'A': [1, 2, 3], 'B': ['a', 'b', 'f']}) + >>> df = pd.DataFrame({'A': [1, 2, 3], 'B': ['a', 'b', 'f']}) >>> df.isin([1, 3, 12, 'a']) A B 0 True True @@ -5950,7 +5950,7 @@ def isin(self, values): When ``values`` is a dict: - >>> df = DataFrame({'A': [1, 2, 3], 'B': [1, 4, 7]}) + >>> df = pd.DataFrame({'A': [1, 2, 3], 'B': [1, 4, 7]}) >>> df.isin({'A': [1, 3], 'B': [4, 7, 12]}) A B 0 True False # Note that B didn't match the 1 here. @@ -5959,7 +5959,7 @@ def isin(self, values): When ``values`` is a Series or DataFrame: - >>> df = DataFrame({'A': [1, 2, 3], 'B': ['a', 'b', 'f']}) + >>> df = pd.DataFrame({'A': [1, 2, 3], 'B': ['a', 'b', 'f']}) >>> other = DataFrame({'A': [1, 3, 3, 2], 'B': ['e', 'f', 'f', 'e']}) >>> df.isin(other) A B From 71fd9ee10df89ba0b96e527d9bcd2b6e305bf226 Mon Sep 17 00:00:00 2001 From: Andy Craze Date: Fri, 15 Dec 2017 18:34:16 -0800 Subject: [PATCH 2/2] fix docstring spacing --- pandas/core/frame.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index e0e072965c77d..65934494b321b 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -3781,8 +3781,8 @@ def nlargest(self, n, columns, keep='first'): Examples -------- >>> df = pd.DataFrame({'a': [1, 10, 8, 11, -1], - ... 'b': list('abdce'), - ... 'c': [1.0, 2.0, np.nan, 3.0, 4.0]}) + ... 'b': list('abdce'), + ... 'c': [1.0, 2.0, np.nan, 3.0, 4.0]}) >>> df.nlargest(3, 'a') a b c 3 11 c 3 @@ -3816,8 +3816,8 @@ def nsmallest(self, n, columns, keep='first'): Examples -------- >>> df = pd.DataFrame({'a': [1, 10, 8, 11, -1], - ... 'b': list('abdce'), - ... 'c': [1.0, 2.0, np.nan, 3.0, 4.0]}) + ... 'b': list('abdce'), + ... 'c': [1.0, 2.0, np.nan, 3.0, 4.0]}) >>> df.nsmallest(3, 'a') a b c 4 -1 e 4