From bf8277a784fbd57a0582314bada9dfbe3c8f16d2 Mon Sep 17 00:00:00 2001 From: Yosuke Nakabayashi Date: Sat, 15 Jul 2017 11:26:52 +0200 Subject: [PATCH 1/3] adding parameter description to head method docstring --- pandas/core/generic.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 5a7f37bba91aa..a08d66a0e337c 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2979,6 +2979,11 @@ def filter(self, items=None, like=None, regex=None, axis=None): def head(self, n=5): """ Returns first n rows + + Parameters + ---------- + n : int, optional + Number of rows. """ return self.iloc[:n] From df5e26d65ae6899fc92e1fcbb610b7025d05e1e3 Mon Sep 17 00:00:00 2001 From: Yosuke Nakabayashi Date: Sat, 15 Jul 2017 11:46:05 +0200 Subject: [PATCH 2/3] adding parameter description to tail method docstring --- pandas/core/generic.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a08d66a0e337c..b2d6b794cbb69 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2990,6 +2990,11 @@ def head(self, n=5): def tail(self, n=5): """ Returns last n rows + + Parameters + ---------- + n : int, optional + Number of rows. """ if n == 0: return self.iloc[0:0] From 50b9bb731d23d5eb894ef0d1cbbb2ef7bf5f096a Mon Sep 17 00:00:00 2001 From: gfyoung Date: Sun, 20 Aug 2017 21:34:44 -0700 Subject: [PATCH 3/3] DOC: Address reviewer comments --- pandas/core/generic.py | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index b2d6b794cbb69..d9d75c870b20c 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2978,24 +2978,36 @@ def filter(self, items=None, like=None, regex=None, axis=None): def head(self, n=5): """ - Returns first n rows + Return the first n rows. Parameters ---------- - n : int, optional - Number of rows. + n : int, default 5 + Number of rows to select. + + Returns + ------- + obj_head : type of caller + The first n rows of the caller object. """ + return self.iloc[:n] def tail(self, n=5): """ - Returns last n rows + Return the last n rows. Parameters ---------- - n : int, optional - Number of rows. + n : int, default 5 + Number of rows to select. + + Returns + ------- + obj_tail : type of caller + The last n rows of the caller object. """ + if n == 0: return self.iloc[0:0] return self.iloc[-n:]