Skip to content

Commit 538fd4d

Browse files
committed
Fix documentation formatting
1 parent 12d0124 commit 538fd4d

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

doc/faq/howto_faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -757,8 +757,8 @@ Cite Matplotlib
757757

758758
If you want to refer to matplotlib in a publication, you can use
759759
"Matplotlib: A 2D Graphics Environment" by J. D. Hunter In Computing
760-
in Science & Engineering, Vol. 9, No. 3. (2007), pp. 90-95 (see `here
761-
<http://dx.doi.org/10.1109/MCSE.2007.55>`_)::
760+
in Science & Engineering, Vol. 9, No. 3. (2007), pp. 90-95 (see `this
761+
reference page <http://dx.doi.org/10.1109/MCSE.2007.55>`_)::
762762

763763
@article{Hunter:2007,
764764
Address = {10662 LOS VAQUEROS CIRCLE, PO BOX 3014, LOS ALAMITOS, CA 90720-1314 USA},

doc/faq/troubleshooting_faq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ Getting help
6868
There are a number of good resources for getting help with matplotlib.
6969
There is a good chance your question has already been asked:
7070

71-
- The `mailing list
71+
- The `mailing list archive
7272
<http://sourceforge.net/search/?group_id=80706&type_of_search=mlists>`_.
7373

7474
- `Github issues <https://github.com/matplotlib/matplotlib/issues>`_.
7575

7676
- Stackoverflow questions tagged `matplotlib
77-
<http://stackoverflow.com/questions/tagged/matplotlib>`_.
77+
<http://stackoverflow.com/questions/tagged/matplotlib>`_.
7878

7979
If you are unable to find an answer to your question through search,
8080
please provide the following information in your e-mail to the

doc/users/license.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ the `PSF <http://www.python.org/psf/license>`_ license. See the Open
1010
Source Initiative `licenses page
1111
<http://www.opensource.org/licenses>`_ for details on individual
1212
licenses. Non-BSD compatible licenses (eg LGPL) are acceptable in
13-
matplotlib :ref:`toolkits-index`. For a discussion of the motivations
14-
behind the licencing choice, see :ref:`license-discussion`.
13+
matplotlib toolkits. For a discussion of the motivations behind the
14+
licencing choice, see :ref:`license-discussion`.
1515

1616

1717
License agreement for matplotlib |version|
@@ -63,8 +63,3 @@ products or services of Licensee, or any third party.
6363
8. By copying, installing or otherwise using matplotlib |version|,
6464
Licensee agrees to be bound by the terms and conditions of this License
6565
Agreement.
66-
67-
68-
69-
70-

lib/matplotlib/axes.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4519,8 +4519,7 @@ def legend(self, *args, **kwargs):
45194519
instance. If *prop* is a dictionary, a new instance will be
45204520
created with *prop*. If *None*, use rc settings.
45214521
4522-
*fontsize*: [ size in points | 'xx-small' | 'x-small' |
4523-
'small' | 'medium' | 'large' | 'x-large' | 'xx-large' ]
4522+
*fontsize*: [ size in points | 'xx-small' | 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | 'xx-large' ]
45244523
Set the font size. May be either a size string, relative to
45254524
the default font size, or an absolute font size in points. This
45264525
argument is only used if prop is not specified.
@@ -7069,7 +7068,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
70697068
parameter, i.e. when interpolation is one of: 'sinc',
70707069
'lanczos' or 'blackman'
70717070
7072-
Additional kwargs are :class:`~matplotlib.artist.Artist` properties:
7071+
Additional kwargs are :class:`~matplotlib.artist.Artist` properties.
70737072
70747073
%(Artist)s
70757074
@@ -7365,13 +7364,13 @@ def pcolor(self, *args, **kwargs):
73657364

73667365
x = X.compressed()
73677366
y = Y.compressed()
7368-
7367+
73697368
# Transform from native to data coordinates?
73707369
t = collection._transform
73717370
if (not isinstance(t, mtransforms.Transform)
73727371
and hasattr(t, '_as_mpl_transform')):
73737372
t = t._as_mpl_transform(self.axes)
7374-
7373+
73757374
if t and any(t.contains_branch_seperately(self.transData)):
73767375
trans_to_data = t - self.transData
73777376
pts = np.vstack([x, y]).T.astype(np.float)
@@ -7505,13 +7504,13 @@ def pcolormesh(self, *args, **kwargs):
75057504
collection.autoscale_None()
75067505

75077506
self.grid(False)
7508-
7507+
75097508
# Transform from native to data coordinates?
75107509
t = collection._transform
75117510
if (not isinstance(t, mtransforms.Transform)
75127511
and hasattr(t, '_as_mpl_transform')):
75137512
t = t._as_mpl_transform(self.axes)
7514-
7513+
75157514
if t and any(t.contains_branch_seperately(self.transData)):
75167515
trans_to_data = t - self.transData
75177516
pts = np.vstack([X, Y]).T.astype(np.float)

lib/matplotlib/legend.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ def __init__(self, parent, handles, labels,
205205
title the legend title
206206
bbox_to_anchor the bbox that the legend will be anchored.
207207
bbox_transform the transform for the bbox. transAxes if None.
208-
================ =====================================================
208+
================ ====================================================
209209
210210
211211
The pad and spacing parameters are measured in font-size units. E.g.,

lib/matplotlib/patches.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2762,9 +2762,12 @@ class Bar(_Base):
27622762
def __init__(self, armA=0., armB=0., fraction=0.3, angle=None):
27632763
"""
27642764
*armA* : minimum length of armA
2765+
27652766
*armB* : minimum length of armB
2767+
27662768
*fraction* : a fraction of the distance between two points that
27672769
will be added to armA and armB.
2770+
27682771
*angle* : angle of the connecting line (if None, parallel to A
27692772
and B)
27702773
"""

lib/matplotlib/streamplot.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,13 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
5252
5353
*stream_container* : StreamplotSet
5454
Container object with attributes
55-
lines: `matplotlib.collections.LineCollection` of streamlines
56-
arrows: collection of `matplotlib.patches.FancyArrowPatch`
57-
objects representing arrows half-way along stream
58-
lines.
55+
56+
- lines: `matplotlib.collections.LineCollection` of streamlines
57+
58+
- arrows: collection of `matplotlib.patches.FancyArrowPatch`
59+
objects representing arrows half-way along stream
60+
lines.
61+
5962
This container will probably change in the future to allow changes
6063
to the colormap, alpha, etc. for both lines and arrows, but these
6164
changes should be backward compatible.

0 commit comments

Comments
 (0)