Skip to content

Commit 88d892a

Browse files
author
y-p
committed
DOC: add FAQ section on dataframe repr display options GH3541
1 parent 734d3ae commit 88d892a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

doc/source/faq.rst

+32
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,38 @@ Frequently Asked Questions (FAQ)
2222
plt.close('all')
2323
options.display.mpl_style='default'
2424
25+
26+
.. _ref-repr-control:
27+
28+
How do I control the way my DataFrame is displayed?
29+
-------------------------------------------
30+
31+
Pandas users rely on a variety of environments for using pandas: scripts, terminal,
32+
IPython qtconsole/ notebook, (IDLE, spyder, etc').
33+
Each environment has it's own capabilities and limitations: HTML support,
34+
horizontal scrolling, auto-detection of width/height.
35+
To appropriately address all these environments, the display behavior is controlled
36+
by several options, which you're encouraged to tweak to suit your setup.
37+
38+
As of 0.11.0, the relavent options are all under the `display` namespace,
39+
(e.g. display.width, display.height, etc'):
40+
- notebook_repr_html: if True, IPython frontends with HTML support will display
41+
dataframes as HTML tables when possible.
42+
- expand_repr (default True): when the frame width cannot fit within the screen,
43+
the output will be broken into multiple pages to accomedate. This applies to
44+
textual (as opposed to HTML) display only.
45+
- max_columns: max dataframe columns to display. a wider frame will trigger
46+
a summary view, unless `expand_repr` is True and HTML output is disabled.
47+
- max_rows: max dataframe rows display. a longer frame will trigger a summary view.
48+
- width: width of display screen in characters. When using a terminal, setting this to None
49+
will trigger auto-detection of terminal width.
50+
- height: height of display screen. When using a terminal, setting this to None
51+
will trigger auto-detection of terminal height.
52+
53+
IPython users can use the IPython startup file to import pandas and set these
54+
options automatically when starting up.
55+
56+
2557
.. _ref-monkey-patching:
2658

2759
Adding Features to your Pandas Installation

0 commit comments

Comments
 (0)