Skip to content

Commit

Permalink
DOC: Clarify that DataFrame string formatters must return strings
Browse files Browse the repository at this point in the history
I am not 100% sure that string formatters must really return *unicode* strings
(non-unicode strings seem to work, too), but I am leaving that because it's
what is already documentated.

Fixes pandas-dev#6052.
  • Loading branch information
shoyer committed Jan 23, 2014
1 parent c6ecf5a commit bfa8eff
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pandas/core/format.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@
string representation of NAN to use, default 'NaN'
formatters : list or dict of one-parameter functions, optional
formatter functions to apply to columns' elements by position or name,
default None, if the result is a string , it must be a unicode
string. List must be of length equal to the number of columns.
default None. The result of each function must be a unicode string.
List must be of length equal to the number of columns.
float_format : one-parameter function, optional
formatter function to apply to columns' elements if they are floats
default None
formatter function to apply to columns' elements if they are floats,
default None. The result of this function must be a unicode string.
sparsify : bool, optional
Set to False for a DataFrame with a hierarchical index to print every
multiindex key at each row, default True
Expand Down

0 comments on commit bfa8eff

Please sign in to comment.