From fc31e58a685a78b92b79001e299d4e3eeaece769 Mon Sep 17 00:00:00 2001 From: "tapumar@gmail.com" Date: Sat, 10 Mar 2018 12:39:13 -0300 Subject: [PATCH 1/2] DOC: improve the docstring of api.types.is_number() --- pandas/core/dtypes/inference.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/pandas/core/dtypes/inference.py b/pandas/core/dtypes/inference.py index 6fed25a0012f2..de152a071f77d 100644 --- a/pandas/core/dtypes/inference.py +++ b/pandas/core/dtypes/inference.py @@ -37,12 +37,22 @@ def is_number(obj): is_number : bool Whether `obj` is a number or not. + See Also + -------- + pandas.api.types.is_integer: checks a subgroup of numbers + Examples -------- >>> is_number(1) True + >>> is_number(7.15) + True + >>> is_number(False) + True >>> is_number("foo") False + >>> is_number("5") + False """ return isinstance(obj, (Number, np.number)) From 0aa91bab9c82e4218a4187d39da075e29892017b Mon Sep 17 00:00:00 2001 From: "tapumar@gmail.com" Date: Sat, 10 Mar 2018 12:59:43 -0300 Subject: [PATCH 2/2] Fix previously modified docstring --- pandas/core/dtypes/inference.py | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/pandas/core/dtypes/inference.py b/pandas/core/dtypes/inference.py index de152a071f77d..a02f0c5b2a4d6 100644 --- a/pandas/core/dtypes/inference.py +++ b/pandas/core/dtypes/inference.py @@ -28,9 +28,12 @@ def is_number(obj): """ Check if the object is a number. + Returns True when the object is a number, and False if is not. + Parameters ---------- - obj : The object to check. + obj : any type + The object to check if is a number. Returns ------- @@ -43,15 +46,19 @@ def is_number(obj): Examples -------- - >>> is_number(1) + >>> pd.api.types.is_number(1) True - >>> is_number(7.15) + >>> pd.api.types.is_number(7.15) True - >>> is_number(False) + + Booleans are valid because they are int subclass. + + >>> pd.api.types.is_number(False) True - >>> is_number("foo") + + >>> pd.api.types.is_number("foo") False - >>> is_number("5") + >>> pd.api.types.is_number("5") False """