Skip to content

Commit f252be6

Browse files
committed
minor docstring cleanups
svn path=/trunk/matplotlib/; revision=5626
1 parent 697830d commit f252be6

File tree

4 files changed

+23
-13
lines changed

4 files changed

+23
-13
lines changed

MANIFEST.in

-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ include lib/matplotlib/mpl-data/fonts/pdfcorefonts/*
1515
include lib/matplotlib/mpl-data/fonts/afm/*
1616
recursive-include license LICENSE*
1717
recursive-include examples *
18-
recursive-include doc *
1918
recursive-include src *.cpp *.c *.h
2019
recursive-include CXX *.cxx *.hxx *.c *.h
2120
recursive-include agg24 *

doc/faq/installing_faq.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ matplotlib targets many different use cases and output formats. Some
104104
people use matplotlib interactively from the python shell and have
105105
plotting windows pop up when they type commands. Some people embed
106106
matplotlib into graphical user interfaces like wxpython or pygtk to
107-
build rich applications. Others use matplotlib in batch scripts, to
107+
build rich applications. Others use matplotlib in batch scripts to
108108
generate postscript images from some numerical simulations, and still
109109
others in web application servers to dynamically serve up graphs.
110110

lib/matplotlib/lines.py

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ def unmasked_index_ranges(mask, compressed = True):
5353
5454
y.filled()[ii[1,0]:ii[1,1]]
5555
# returns np.array [3,4,]
56+
5657
'''
5758
m = np.concatenate(((1,), mask, (1,)))
5859
indices = np.arange(len(mask) + 1)

lib/matplotlib/patches.py

+21-11
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,10 @@ def set_hatch(self, h):
221221
222222
CURRENT LIMITATIONS:
223223
224-
1. Hatching is supported in the PostScript backend only.
224+
1. Hatching is supported in the PostScript backend only.
225+
226+
2. Hatching is done with solid black lines of width 0.
225227
226-
2. Hatching is done with solid black lines of width 0.
227228
"""
228229
self._hatch = h
229230

@@ -345,6 +346,7 @@ def __str__(self):
345346

346347
def __init__(self, xy, width, height, **kwargs):
347348
"""
349+
348350
*fill* is a boolean indicating whether to fill the rectangle
349351
350352
Valid kwargs are:
@@ -460,6 +462,8 @@ def __str__(self):
460462
def __init__(self, xy, numVertices, radius=5, orientation=0,
461463
**kwargs):
462464
"""
465+
Constructor arguments:
466+
463467
*xy*
464468
A length 2 tuple (*x*, *y*) of the center.
465469
@@ -685,18 +689,20 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False, \
685689
head_width=None, head_length=None, shape='full', overhang=0, \
686690
head_starts_at_zero=False,**kwargs):
687691
"""
688-
*length_includes_head*:
689-
*True* if head is counted in calculating the length.
692+
Constructor arguments
690693
691-
*shape*: ['full', 'left', 'right']
694+
*length_includes_head*:
695+
*True* if head is counted in calculating the length.
692696
693-
*overhang*:
694-
distance that the arrow is swept back (0 overhang means
695-
triangular shape).
697+
*shape*: ['full', 'left', 'right']
696698
697-
*head_starts_at_zero*:
698-
If *True*, the head starts being drawn at coordinate 0
699-
instead of ending at coordinate 0.
699+
*overhang*:
700+
distance that the arrow is swept back (0 overhang means
701+
triangular shape).
702+
703+
*head_starts_at_zero*:
704+
If *True*, the head starts being drawn at coordinate 0
705+
instead of ending at coordinate 0.
700706
701707
Valid kwargs are:
702708
%(Patch)s
@@ -761,6 +767,8 @@ def __str__(self):
761767

762768
def __init__(self, figure, xytip, xybase, width=4, frac=0.1, headwidth=12, **kwargs):
763769
"""
770+
Constructor arguments:
771+
764772
*xytip*
765773
(*x*, *y*) location of arrow tip
766774
@@ -972,6 +980,8 @@ def __str__(self):
972980

973981
def __init__(self, xy, width, height, angle=0.0, theta1=0.0, theta2=360.0, **kwargs):
974982
"""
983+
The following args are supported:
984+
975985
*xy*
976986
center of ellipse
977987

0 commit comments

Comments
 (0)