Skip to content

DOC: update pandas/core/ops.py docstring with examples for pandas.DataFrame.gt and .ge methods #20291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ParfaitG wants to merge 2 commits into from
Closed

DOC: update pandas/core/ops.py docstring with examples for pandas.DataFrame.gt and .ge methods #20291

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acab08e
DOC: Add examples for DataFrame.gt() and DataFrame.ge()
ParfaitG Mar 11, 2018
1818aeb
Merge branch 'master' of github.com:pandas-dev/pandas into docstring_gt
ParfaitG Mar 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 62 additions & 2 deletions pandas/core/ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,66 @@ def _get_op_name(op, special):
e NaN 2.0
"""

_gt_example_FRAME = """
>>> df1 = pd.DataFrame({'num1': range(1,6),
'num2': range(2,11,2),
'num3': range(1,20,4)})
>>> df1
num1 num2 num3
0 1 2 1
1 2 4 5
2 3 6 9
3 4 8 13
4 5 10 17
>>> df2 = pd.DataFrame({'num1': range(6,11),
'num2': range(1,10,2),
'num3': range(1,20,4)})
>>> df2
num1 num2 num3
0 6 1 1
1 7 3 5
2 8 5 9
3 9 7 13
4 10 9 17
>>> df1.gt(df2)
num1 num2 num3
0 False True False
1 False True False
2 False True False
3 False True False
4 False True False
"""

_ge_example_FRAME = """
>>> df1 = pd.DataFrame({'num1': range(1,6),
'num2': range(2,11,2),
'num3': range(1,20,4)})
>>> df1
num1 num2 num3
0 1 2 1
1 2 4 5
2 3 6 9
3 4 8 13
4 5 10 17
>>> df2 = pd.DataFrame({'num1': range(6,11),
'num2': range(1,10,2),
'num3': range(1,20,4)})
>>> df2
num1 num2 num3
0 6 1 1
1 7 3 5
2 8 5 9
3 9 7 13
4 10 9 17
>>> df1.ge(df2)
num1 num2 num3
0 False True True
1 False True True
2 False True True
3 False True True
4 False True True
"""

_op_descriptions = {
# Arithmetic Operators
'add': {'op': '+',
Expand Down Expand Up @@ -425,11 +485,11 @@ def _get_op_name(op, special):
'gt': {'op': '>',
'desc': 'Greater than',
'reverse': None,
'df_examples': None},
'df_examples': _gt_example_FRAME},
'ge': {'op': '>=',
'desc': 'Greater than or equal to',
'reverse': None,
'df_examples': None}}
'df_examples': _ge_example_FRAME}}

_op_names = list(_op_descriptions.keys())
for key in _op_names:
Expand Down