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

Skip to content

Commit 8e00ba3

Browse files
mdboommdboom
committed
Fix numerous documentation warnings.
svn path=/trunk/matplotlib/; revision=6594
1 parent bb4425a commit 8e00ba3

14 files changed

Lines changed: 108 additions & 50 deletions

File tree

‎doc/api/font_manager_api.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ matplotlib font_manager
1111
:show-inheritance:
1212

1313
:mod:`matplotlib.fontconfig_pattern`
14-
==============================
14+
====================================
1515

1616
.. automodule:: matplotlib.fontconfig_pattern
1717
:members:

‎doc/faq/howto_faq.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,8 +428,10 @@ pyplot::
428428

429429
.. seealso::
430430
:ref:`howto-webapp`
431+
For information about running matplotlib inside of a web
432+
application.
431433

432-
.. _howto-show
434+
.. _howto-show:
433435

434436
Use :func:`~matplotlib.pyplot.show`
435437
------------------------------------------

‎doc/users/event_handling.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ Event name Class and description
6464
'scroll_event' :class:`~matplotlib.backend_bases.MouseEvent` - mouse scroll wheel is rolled
6565
'figure_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse enters a new figure
6666
'figure_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse leaves a figure
67-
'axes_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse enters a new axes
68-
'axes_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse leaves an axes
67+
'axes_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse enters a new axes
68+
'axes_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse leaves an axes
6969
======================= ======================================================================================
7070

7171
.. _event-attributes:

‎lib/matplotlib/artist.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,10 @@ def remove_callback(self, oid):
144144
Remove a callback based on its *id*.
145145
146146
.. seealso::
147+
147148
:meth:`add_callback`
149+
For adding callbacks
150+
148151
"""
149152
try: del self._propobservers[oid]
150153
except KeyError: pass
@@ -497,7 +500,7 @@ def draw(self, renderer, *args, **kwargs):
497500
def set_alpha(self, alpha):
498501
"""
499502
Set the alpha value used for blending - not supported on
500-
all backends
503+
all backends.
501504
502505
ACCEPTS: float (0.0 transparent through 1.0 opaque)
503506
"""

‎lib/matplotlib/axes.py‎

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ def _process_plot_format(fmt):
4343
* 'r--': red dashed lines
4444
4545
.. seealso::
46+
4647
:func:`~matplotlib.Line2D.lineStyles` and
47-
:func:`~matplotlib.pyplot.colors`:
48+
:func:`~matplotlib.pyplot.colors`
4849
for all possible styles and color format string.
4950
"""
5051

@@ -2574,7 +2575,8 @@ def set_title(self, label, fontdict=None, **kwargs):
25742575
ACCEPTS: str
25752576
25762577
.. seealso::
2577-
:meth:`text`:
2578+
2579+
:meth:`text`
25782580
for information on how override and the optional args work
25792581
"""
25802582
default = {
@@ -2610,7 +2612,8 @@ def set_xlabel(self, xlabel, fontdict=None, **kwargs):
26102612
ACCEPTS: str
26112613
26122614
.. seealso::
2613-
:meth:`text`:
2615+
2616+
:meth:`text`
26142617
for information on how override and the optional args work
26152618
"""
26162619

@@ -2641,7 +2644,8 @@ def set_ylabel(self, ylabel, fontdict=None, **kwargs):
26412644
ACCEPTS: str
26422645
26432646
.. seealso::
2644-
:meth:`text`:
2647+
2648+
:meth:`text`
26452649
for information on how override and the optional args work
26462650
"""
26472651
label = self.yaxis.get_label()
@@ -2794,7 +2798,8 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
27942798
%(Line2D)s
27952799
27962800
.. seealso::
2797-
:meth:`axhspan`:
2801+
2802+
:meth:`axhspan`
27982803
for example plot and source code
27992804
"""
28002805

@@ -2853,7 +2858,8 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
28532858
%(Line2D)s
28542859
28552860
.. seealso::
2856-
:meth:`axhspan`:
2861+
2862+
:meth:`axhspan`
28572863
for example plot and source code
28582864
"""
28592865

@@ -2964,7 +2970,8 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
29642970
%(Polygon)s
29652971
29662972
.. seealso::
2967-
:meth:`axhspan`:
2973+
2974+
:meth:`axhspan`
29682975
for example plot and source code
29692976
"""
29702977
trans = mtransforms.blended_transform_factory(
@@ -3331,12 +3338,13 @@ def plot_date(self, x, y, fmt='bo', tz=None, xdate=True, ydate=False,
33313338
%(Line2D)s
33323339
33333340
.. seealso::
3334-
:mod:`~matplotlib.dates`:
3341+
3342+
:mod:`~matplotlib.dates`
33353343
for helper functions
33363344
33373345
:func:`~matplotlib.dates.date2num`,
33383346
:func:`~matplotlib.dates.num2date` and
3339-
:func:`~matplotlib.dates.drange`:
3347+
:func:`~matplotlib.dates.drange`
33403348
for help on creating the required floating point
33413349
dates.
33423350
"""
@@ -3439,7 +3447,8 @@ def semilogx(self, *args, **kwargs):
34393447
%(Line2D)s
34403448
34413449
.. seealso::
3442-
:meth:`loglog`:
3450+
3451+
:meth:`loglog`
34433452
For example code and figure
34443453
"""
34453454
if not self._hold: self.cla()
@@ -3484,7 +3493,8 @@ def semilogy(self, *args, **kwargs):
34843493
%(Line2D)s
34853494
34863495
.. seealso::
3487-
:meth:`loglog`:
3496+
3497+
:meth:`loglog`
34883498
For example code and figure
34893499
"""
34903500
if not self._hold: self.cla()
@@ -3546,9 +3556,10 @@ def acorr(self, x, **kwargs):
35463556
- *b* is the *x*-axis.
35473557
35483558
.. seealso::
3559+
35493560
:meth:`~matplotlib.axes.Axes.plot` or
3550-
:meth:`~matplotlib.axes.Axes.vlines`: For documentation on
3551-
valid kwargs.
3561+
:meth:`~matplotlib.axes.Axes.vlines`
3562+
For documentation on valid kwargs.
35523563
35533564
**Example:**
35543565
@@ -4249,10 +4260,12 @@ def stem(self, x, y, linefmt='b-', markerfmt='bo', basefmt='r-'):
42494260
*baseline*).
42504261
42514262
.. seealso::
4252-
`this document`__ for details
42534263
4254-
:file:`examples/pylab_examples/stem_plot.py`:
4255-
for a demo
4264+
`this document`__
4265+
for details
4266+
4267+
:file:`examples/pylab_examples/stem_plot.py`
4268+
for a demo
42564269
42574270
__ http://www.mathworks.com/access/helpdesk/help/techdoc/ref/stem.html
42584271
@@ -5594,7 +5607,7 @@ def fill_between(self, x, y1, y2=0, where=None, **kwargs):
55945607
55955608
%(PolyCollection)s
55965609
5597-
.. plot:: mpl_examples/pylab_examples/fill_between.py
5610+
.. plot:: mpl_examples/pylab_examples/fill_between.py
55985611
"""
55995612
# Handle united data, such as dates
56005613
self._process_unit_info(xdata=x, ydata=y1, kwargs=kwargs)
@@ -6093,7 +6106,8 @@ def pcolormesh(self, *args, **kwargs):
60936106
%(QuadMesh)s
60946107
60956108
.. seealso::
6096-
:func:`~matplotlib.pyplot.pcolor`:
6109+
6110+
:func:`~matplotlib.pyplot.pcolor`
60976111
For an explanation of the grid orientation and the
60986112
expansion of 1-D *X* and/or *Y* to 2-D arrays.
60996113
"""
@@ -6424,7 +6438,7 @@ def get_shared_y_axes(self):
64246438

64256439
def hist(self, x, bins=10, range=None, normed=False, weights=None,
64266440
cumulative=False, bottom=None, histtype='bar', align='mid',
6427-
orientation='vertical', rwidth=None, log=False,
6441+
orientation='vertical', rwidth=None, log=False,
64286442
**kwargs):
64296443
"""
64306444
call signature::
@@ -6896,6 +6910,7 @@ def csd(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
68966910
.. plot:: mpl_examples/pylab_examples/csd_demo.py
68976911
68986912
.. seealso:
6913+
68996914
:meth:`psd`
69006915
For a description of the optional parameters.
69016916
"""
@@ -7093,7 +7108,9 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
70937108
* *alpha*
70947109
70957110
.. seealso::
7111+
70967112
:func:`~matplotlib.pyplot.imshow`
7113+
For image options.
70977114
70987115
For controlling colors, e.g. cyan background and red marks,
70997116
use::
@@ -7114,7 +7131,9 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
71147131
* ',' pixel
71157132
71167133
.. seealso::
7134+
71177135
:func:`~matplotlib.pyplot.plot`
7136+
For plotting options
71187137
"""
71197138
if precision is None:
71207139
precision = 0

‎lib/matplotlib/collections.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,9 @@ def set_color(self, c):
354354
ACCEPTS: matplotlib color arg or sequence of rgba tuples
355355
356356
.. seealso::
357+
357358
:meth:`set_facecolor`, :meth:`set_edgecolor`
359+
For setting the edge or face color individually.
358360
"""
359361
self.set_facecolor(c)
360362
self.set_edgecolor(c)
@@ -702,8 +704,8 @@ def span_where(x, ymin, ymax, where, **kwargs):
702704
over the regions in *x* where *where* is True. The bars range
703705
on the y-axis from *ymin* to *ymax*
704706
705-
A :class:`BrokenBarHCollection` is returned.
706-
**kwargs are passed on to the collection
707+
A :class:`BrokenBarHCollection` is returned. kwargs are
708+
passed on to the collection.
707709
"""
708710
xranges = []
709711
for ind0, ind1 in mlab.contiguous_regions(where):
@@ -932,7 +934,7 @@ def set_color(self, c):
932934
Set the color(s) of the line collection. *c* can be a
933935
matplotlib color arg (all patches have same color), or a
934936
sequence or rgba tuples; if it is a sequence the patches will
935-
cycle through the sequence
937+
cycle through the sequence.
936938
937939
ACCEPTS: matplotlib color arg or sequence of rgba tuples
938940
"""

‎lib/matplotlib/colors.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,9 @@ def __init__(self, name, segmentdata, N=256):
594594
595595
596596
.. seealso::
597+
597598
:func:`makeMappingArray`
599+
For information about making a mapping array.
598600
"""
599601
self.monochrome = False # True only if all colors in map are identical;
600602
# needed for contouring.

‎lib/matplotlib/lines.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,9 @@ def set_linestyle(self, linestyle):
622622
backward-compatibility.
623623
624624
.. seealso::
625+
625626
:meth:`set_drawstyle`
627+
To set the drawing style (stepping) of the plot.
626628
627629
ACCEPTS: [ '-' | '--' | '-.' | ':' | 'None' | ' ' | '' ] and
628630
any drawstyle in combination with a linestyle, e.g. 'steps--'.

0 commit comments

Comments
 (0)