Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 00cf4a4

Browse files
ddaleddale
committed
do not use column- or row-spanning cells in rest tables.
Such tables can not be converted to latex by sphinx. svn path=/trunk/matplotlib/; revision=5349
1 parent f885bfc commit 00cf4a4

6 files changed

Lines changed: 209 additions & 253 deletions

File tree

‎doc/api/pyplot_api.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
matplotlib pyplot
33
*****************
44

5+
56
:mod:`matplotlib.pyplot`
67
=============================
78

89
.. automodule:: matplotlib.pyplot
9-
:members: acorr
10+
:members:

‎doc/devel/documenting_mpl.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ possible to include other documents through the use of an include
3030
statement. For example, in the Developers Guide, index.rst lists
3131
coding_guide, which automatically inserts coding_guide.rst.
3232

33+
Sphinx does not support tables with column- or row-spanning cells for
34+
latex output. Such tables can not be used when documenting matplotlib.
35+
3336
Mathematical expressions can be rendered as png images in html, and in
3437
the usual way by latex. For example:
3538

‎lib/matplotlib/axes.py‎

Lines changed: 71 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -3888,7 +3888,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
38883888
call signature::
38893889
38903890
errorbar(x, y, yerr=None, xerr=None,
3891-
fmt='b-', ecolor=None, elinewidth=None, capsize=3,
3891+
fmt='-', ecolor=None, elinewidth=None, capsize=3,
38923892
barsabove=False, lolims=False, uplims=False,
38933893
xlolims=False, xuplims=False)
38943894
@@ -3901,38 +3901,30 @@ def errorbar(self, x, y, yerr=None, xerr=None,
39013901
39023902
Optional keyword arguments:
39033903
3904-
+------------+------------------------------------------------------+
3905-
| Keyword | Description |
3906-
+============+======================================================+
3907-
| xerr | a rank-0 or Nx1 Numpy array yields symmetric |
3908-
| yerr | errorbars +/- value |
3909-
| +------------------------------------------------------+
3910-
| | an N-element list or tuple yields symmetric |
3911-
| | errorbars +/- value |
3912-
| +------------------------------------------------------+
3913-
| | a rank-1, Nx2 Numpy array yields asymmetric |
3914-
| | errorbars: -column1/+column2 |
3915-
+------------+------------------------------------------------------+
3916-
| fmt | the plot format symbol for y. If fmt is None, just |
3917-
| | plot the errorbars with no line symbols. This can |
3918-
| | be useful for creating a bar plot with errorbars |
3919-
+------------+------------------------------------------------------+
3920-
| ecolor | a matplotlib color arg which gives the color the |
3921-
| | errorbar lines; if None, use the marker color. |
3922-
+------------+------------------------------------------------------+
3923-
| elinewidth | the linewidth of the errorbar lines. If None, use |
3924-
| | the linewidth. |
3925-
+------------+------------------------------------------------------+
3926-
| capsize | the size of the error bar caps in points |
3927-
+------------+------------------------------------------------------+
3928-
| barsabove | if True, will plot the errorbars above the plot |
3929-
| | symbols. Default is below. |
3930-
+------------+------------------------------------------------------+
3931-
| lolims | These arguments can be used to indicate that a value |
3932-
| uplims | gives only upper/lower limits. In that case a caret |
3933-
| xlolims | symbol is used to indicate this. lims-arguments may |
3934-
| xuplims | be of the same type as xerr and yerr. |
3935-
+------------+------------------------------------------------------+
3904+
xerr/yerr: [ scalar | N, Nx1, Nx2 array-like ]
3905+
If a scalar number, len(N) array-like object, or an Nx1 array-like
3906+
object, errorbars are drawn +/- value.
3907+
3908+
If a rank-1, Nx2 Numpy array, errorbars are drawn at -column1 and
3909+
+column2
3910+
fmt: '-'
3911+
The plot format symbol for y. If fmt is None, just plot the
3912+
errorbars with no line symbols. This can be useful for creating a
3913+
bar plot with errorbars.
3914+
ecolor: [ None | mpl color ]
3915+
a matplotlib color arg which gives the color the errorbar lines; if
3916+
None, use the marker color.
3917+
elinewidth: scalar
3918+
the linewidth of the errorbar lines. If None, use the linewidth.
3919+
capsize: scalar
3920+
the size of the error bar caps in points
3921+
barsabove: [ True | False ]
3922+
if True, will plot the errorbars above the plot symbols. Default is
3923+
below.
3924+
lolims/uplims/xlolims/xuplims: [ False | True ]
3925+
These arguments can be used to indicate that a value gives only
3926+
upper/lower limits. In that case a caret symbol is used to indicate
3927+
this. lims-arguments may be of the same type as xerr and yerr.
39363928
39373929
All other keyword arguments are passed on to the plot command for the
39383930
markers, so you can add additional key=value pairs to control the
@@ -4594,73 +4586,61 @@ def hexbin(self, x, y, gridsize = 100, bins = None,
45944586
45954587
Optional keyword arguments:
45964588
4597-
+----------+---------------------------------------------------------+
4598-
| Keyword | Description |
4599-
+==========+=========================================================+
4600-
| gridsize | The number of hexagons in the x-direction, default is |
4601-
| | 100. The corresponding number of hexagons in the |
4602-
| | y-direction is chosen such that the hexagons are |
4603-
| | approximately regular. Alternatively, gridsize can be a |
4604-
| | tuple with two elements specifying the number of |
4605-
| | hexagons in the x-direction and the y-direction. |
4606-
+----------+---------------------------------------------------------+
4607-
| bins | If None, no binning is applied; the color of each |
4608-
| | hexagon directly corresponds to its count value. |
4609-
| +---------------------------------------------------------+
4610-
| | If 'log', use a logarithmic scale for the color |
4611-
| | map. Internally, log10(count+1) is used to determine |
4612-
| | the hexagon color. |
4613-
| +---------------------------------------------------------+
4614-
| | If an integer, divide the counts in the specified |
4615-
| | number of bins, and color the hexagons accordingly |
4616-
| +---------------------------------------------------------+
4617-
| | I a sequence of values, the values of the lower bound |
4618-
| | of the bins to be used. |
4619-
+----------+---------------------------------------------------------+
4620-
| xscale | [ 'linear' | 'log' ] |
4621-
| | Use a log10 scale on the horizontal axis. |
4622-
+----------+---------------------------------------------------------+
4623-
| yscale | [ 'linear' | 'log' ] |
4624-
| | Use a log10 scale on the vertical axis. |
4625-
+----------+---------------------------------------------------------+
4589+
gridsize: [ 100 | integer ]
4590+
The number of hexagons in the x-direction, default is 100. The
4591+
corresponding number of hexagons in the y-direction is chosen such
4592+
that the hexagons are approximately regular. Alternatively,
4593+
gridsize can be a tuple with two elements specifying the number of
4594+
hexagons in the x-direction and the y-direction.
4595+
bins: [ None | 'log' | integer | sequence ]
4596+
If None, no binning is applied; the color of each hexagon directly
4597+
corresponds to its count value.
4598+
4599+
If 'log', use a logarithmic scale for the color map. Internally,
4600+
log10(count+1) is used to determine the hexagon color.
4601+
4602+
If an integer, divide the counts in the specified number of bins,
4603+
and color the hexagons accordingly.
4604+
4605+
I a sequence of values, the values of the lower bound of the bins
4606+
to be used.
4607+
xscale: [ 'linear' | 'log' ]
4608+
Use a linear or log10 scale on the horizontal axis.
4609+
scale: [ 'linear' | 'log' ]
4610+
Use a linear or log10 scale on the vertical axis.
46264611
46274612
Other keyword arguments controlling color mapping and normalization
46284613
arguments:
46294614
4630-
========== ======================================================
4631-
Keyword Description
4632-
========== ======================================================
4633-
cmap a colors.Colormap instance from cm. defaults to rc
4634-
image.cmap
4635-
norm colors.Normalize instance is used to scale luminance
4636-
data to 0,1.
4637-
vmin/vmax vmin and vmax are used in conjunction with norm to
4638-
normalize luminance data. If either are None, the
4639-
min and max of the color array C is used. Note if you
4640-
pass a norm instance, your settings for vmin and vmax
4641-
will be ignored
4642-
alpha the alpha value for the patches
4643-
linewidths if None, defaults to (lines.linewidth,). Note
4644-
that this is a tuple, and if you set the linewidths
4645-
argument you must set it as a sequence of floats, as
4646-
required by RegularPolyCollection -- see
4647-
collections.RegularPolyCollection for details
4648-
========== ======================================================
4615+
cmap: [ None | Colormap ]
4616+
a colors.Colormap instance from cm. If None, defaults to rc
4617+
image.cmap.
4618+
norm: [ None | Normalize ]
4619+
colors.Normalize instance is used to scale luminance data to 0,1.
4620+
vmin/vmax: scalar
4621+
vmin and vmax are used in conjunction with norm to normalize
4622+
luminance data. If either are None, the min and max of the color
4623+
array C is used. Note if you pass a norm instance, your settings
4624+
for vmin and vmax will be ignored.
4625+
alpha: scalar
4626+
the alpha value for the patches
4627+
linewidths: [ None | scalar ]
4628+
If None, defaults to rc lines.linewidth. Note that this is a tuple,
4629+
and if you set the linewidths argument you must set it as a
4630+
sequence of floats, as required by RegularPolyCollection -- see
4631+
collections.RegularPolyCollection for details.
46494632
46504633
Other keyword arguments controlling the Collection properties:
46514634
4652-
========== ======================================================
4653-
Keyword Description
4654-
========== ======================================================
4655-
edgecolors if 'none', draws the edges in the same color as the
4656-
fill color. This is the default, as it avoids
4657-
unsightly unpainted pixels between the hexagons.
4635+
edgecolors: [ None | mpl color | color sequence ]
4636+
If 'none', draws the edges in the same color as the fill color.
4637+
This is the default, as it avoids unsightly unpainted pixels
4638+
between the hexagons.
46584639
4659-
if None, draws the outlines in the default color.
4640+
If None, draws the outlines in the default color.
46604641
4661-
if a matplotlib color arg or sequence of rgba tuples,
4662-
draws the outlines in the specified color.
4663-
========== ======================================================
4642+
If a matplotlib color arg or sequence of rgba tuples, draws the
4643+
outlines in the specified color.
46644644
46654645
Here are the standard descriptions of all the Collection kwargs:
46664646
%(Collection)s

0 commit comments

Comments
 (0)