Skip to content

Commit

Permalink
minor docstring cleanups
Browse files Browse the repository at this point in the history
svn path=/trunk/matplotlib/; revision=5626
  • Loading branch information
jdh2358 committed Jun 21, 2008
1 parent 697830d commit f252be6
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 13 deletions.
1 change: 0 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ include lib/matplotlib/mpl-data/fonts/pdfcorefonts/*
include lib/matplotlib/mpl-data/fonts/afm/*
recursive-include license LICENSE*
recursive-include examples *
recursive-include doc *
recursive-include src *.cpp *.c *.h
recursive-include CXX *.cxx *.hxx *.c *.h
recursive-include agg24 *
Expand Down
2 changes: 1 addition & 1 deletion doc/faq/installing_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ matplotlib targets many different use cases and output formats. Some
people use matplotlib interactively from the python shell and have
plotting windows pop up when they type commands. Some people embed
matplotlib into graphical user interfaces like wxpython or pygtk to
build rich applications. Others use matplotlib in batch scripts, to
build rich applications. Others use matplotlib in batch scripts to
generate postscript images from some numerical simulations, and still
others in web application servers to dynamically serve up graphs.

Expand Down
1 change: 1 addition & 0 deletions lib/matplotlib/lines.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def unmasked_index_ranges(mask, compressed = True):
y.filled()[ii[1,0]:ii[1,1]]
# returns np.array [3,4,]
'''
m = np.concatenate(((1,), mask, (1,)))
indices = np.arange(len(mask) + 1)
Expand Down
32 changes: 21 additions & 11 deletions lib/matplotlib/patches.py
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,10 @@ def set_hatch(self, h):
CURRENT LIMITATIONS:
1. Hatching is supported in the PostScript backend only.
1. Hatching is supported in the PostScript backend only.
2. Hatching is done with solid black lines of width 0.
2. Hatching is done with solid black lines of width 0.
"""
self._hatch = h

Expand Down Expand Up @@ -345,6 +346,7 @@ def __str__(self):

def __init__(self, xy, width, height, **kwargs):
"""
*fill* is a boolean indicating whether to fill the rectangle
Valid kwargs are:
Expand Down Expand Up @@ -460,6 +462,8 @@ def __str__(self):
def __init__(self, xy, numVertices, radius=5, orientation=0,
**kwargs):
"""
Constructor arguments:
*xy*
A length 2 tuple (*x*, *y*) of the center.
Expand Down Expand Up @@ -685,18 +689,20 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False, \
head_width=None, head_length=None, shape='full', overhang=0, \
head_starts_at_zero=False,**kwargs):
"""
*length_includes_head*:
*True* if head is counted in calculating the length.
Constructor arguments
*shape*: ['full', 'left', 'right']
*length_includes_head*:
*True* if head is counted in calculating the length.
*overhang*:
distance that the arrow is swept back (0 overhang means
triangular shape).
*shape*: ['full', 'left', 'right']
*head_starts_at_zero*:
If *True*, the head starts being drawn at coordinate 0
instead of ending at coordinate 0.
*overhang*:
distance that the arrow is swept back (0 overhang means
triangular shape).
*head_starts_at_zero*:
If *True*, the head starts being drawn at coordinate 0
instead of ending at coordinate 0.
Valid kwargs are:
%(Patch)s
Expand Down Expand Up @@ -761,6 +767,8 @@ def __str__(self):

def __init__(self, figure, xytip, xybase, width=4, frac=0.1, headwidth=12, **kwargs):
"""
Constructor arguments:
*xytip*
(*x*, *y*) location of arrow tip
Expand Down Expand Up @@ -972,6 +980,8 @@ def __str__(self):

def __init__(self, xy, width, height, angle=0.0, theta1=0.0, theta2=360.0, **kwargs):
"""
The following args are supported:
*xy*
center of ellipse
Expand Down

0 comments on commit f252be6

Please sign in to comment.