Skip to content

Commit f4782da

Browse files
committed
DOC : add note about np.matrix and pandas objects
There is no intentional support for np.matrix or pandas data objects as input to plotting functions.
1 parent 4ff936e commit f4782da

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/faq/usage_faq.rst

+9
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,15 @@ idea). When the figure is rendered, all of the artists are drawn to
114114
the **canvas**. Most Artists are tied to an Axes; such an Artist
115115
cannot be shared by multiple Axes, or moved from one to another.
116116

117+
.. _input_types:
118+
119+
Types of inputs to plotting functions
120+
=====================================
121+
122+
All of plotting functions expect `np.array` or `np.ma.masked_array` as
123+
input. Classes that are 'array-like' such as `pandas` data objects
124+
and `np.matrix` may or may not work as intended. It is best to
125+
convert these to `np.array` objects prior to plotting.
117126

118127
.. _pylab:
119128

0 commit comments

Comments
 (0)