Skip to content

Commit 5c2be67

Browse files
committed
DOC: add docstring
1 parent 4618675 commit 5c2be67

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

pandas/util/terminal.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
get_terminal_size() -- return width and height of console as a tuple
2+
get_terminal_size() -- return width and height of terminal as a tuple
33
44
code from:
55
http://stackoverflow.com/questions/566746/how-to-get-console- window-width-in-
@@ -18,6 +18,12 @@
1818

1919

2020
def get_terminal_size():
21+
"""
22+
Detect terminal size and return tuple = (width, height).
23+
24+
Only to be used when running in a terminal. Note that the IPython notebook,
25+
IPython qtconsole, or IDLE do not run in a terminal,
26+
"""
2127
import platform
2228
current_os = platform.system()
2329
tuple_xy = None

0 commit comments

Comments
 (0)