DOC: Remove redundant call signatures.

QuLogic · QuLogic · commit 94a7cd6fe99f · 2016-01-05T22:39:30.000-05:00
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -424,10 +424,6 @@ def pickable(self):
 
     def pick(self, mouseevent):
         """
-        call signature::
-
-          pick(mouseevent)
-
         each child artist will fire a pick event if *mouseevent* is over
         the artist and the artist has picker set
         """
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -822,10 +822,6 @@ def axhspan(self, ymin, ymax, xmin=0, xmax=1, **kwargs):
         """
         Add a horizontal span (rectangle) across the axis.
 
-        Call signature::
-
-          axhspan(ymin, ymax, xmin=0, xmax=1, **kwargs)
-
         *y* coords are in data units and *x* coords are in axes (relative
         0-1) units.
 
@@ -877,10 +873,6 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
         """
         Add a vertical span (rectangle) across the axes.
 
-        Call signature::
-
-          axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs)
-
         *x* coords are in data units and *y* coords are in axes (relative
         0-1) units.
 
@@ -1099,12 +1091,6 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
         """
         Plot identical parallel lines at specific positions.
 
-        Call signature::
-
-          eventplot(positions, orientation='horizontal', lineoffsets=0,
-                    linelengths=1, linewidths=None, color =None,
-                    linestyles='solid'
-
         Plot parallel lines at the given positions.  positions should be a 1D
         or 2D array-like object, with each row corresponding to a row or column
         of lines.
@@ -1435,11 +1421,6 @@ def plot_date(self, x, y, fmt='o', tz=None, xdate=True, ydate=False,
         """
         Plot with data with dates.
 
-        Call signature::
-
-           plot_date(x, y, fmt='bo', tz=None, xdate=True,
-                     ydate=False, **kwargs)
-
         Similar to the :func:`~matplotlib.pyplot.plot` command, except
         the *x* or *y* (or both) data is considered to be dates, and the
         axis is labeled accordingly.
@@ -1508,10 +1489,6 @@ def loglog(self, *args, **kwargs):
         """
         Make a plot with log scaling on both the *x* and *y* axis.
 
-        Call signature::
-
-          loglog(*args, **kwargs)
-
         :func:`~matplotlib.pyplot.loglog` supports all the keyword
         arguments of :func:`~matplotlib.pyplot.plot` and
         :meth:`matplotlib.axes.Axes.set_xscale` /
@@ -1570,10 +1547,6 @@ def semilogx(self, *args, **kwargs):
         """
         Make a plot with log scaling on the *x* axis.
 
-        Call signature::
-
-          semilogx(*args, **kwargs)
-
         :func:`semilogx` supports all the keyword arguments of
         :func:`~matplotlib.pyplot.plot` and
         :meth:`matplotlib.axes.Axes.set_xscale`.
@@ -1623,10 +1596,6 @@ def semilogy(self, *args, **kwargs):
         """
         Make a plot with log scaling on the *y* axis.
 
-        call signature::
-
-          semilogy(*args, **kwargs)
-
         :func:`semilogy` supports all the keyword arguments of
         :func:`~matplotlib.pylab.plot` and
         :meth:`matplotlib.axes.Axes.set_yscale`.
@@ -1827,10 +1796,6 @@ def step(self, x, y, *args, **kwargs):
         """
         Make a step plot.
 
-        Call signature::
-
-          step(x, y, *args, **kwargs)
-
         Additional keyword args to :func:`step` are the same as those
         for :func:`~matplotlib.pyplot.plot`.
 
@@ -2301,10 +2266,6 @@ def broken_barh(self, xranges, yrange, **kwargs):
         """
         Plot horizontal bars.
 
-        Call signature::
-
-          broken_barh(self, xranges, yrange, **kwargs)
-
         A collection of horizontal bars spanning *yrange* with a sequence of
         *xranges*.
 
@@ -2454,15 +2415,6 @@ def pie(self, x, explode=None, labels=None, colors=None,
         r"""
         Plot a pie chart.
 
-        Call signature::
-
-          pie(x, explode=None, labels=None,
-              colors=('b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'),
-              autopct=None, pctdistance=0.6, shadow=False,
-              labeldistance=1.1, startangle=None, radius=None,
-              counterclock=True, wedgeprops=None, textprops=None,
-              center = (0, 0), frame = False )
-
         Make a pie chart of array *x*.  The fractional area of each
         wedge is given by x/sum(x).  If sum(x) <= 1, then the values
         of x give the fractional area directly and the array will not
@@ -2676,14 +2628,6 @@ def errorbar(self, x, y, yerr=None, xerr=None,
         """
         Plot an errorbar graph.
 
-        Call signature::
-
-          errorbar(x, y, yerr=None, xerr=None,
-                   fmt='', ecolor=None, elinewidth=None, capsize=None,
-                   barsabove=False, lolims=False, uplims=False,
-                   xlolims=False, xuplims=False, errorevery=1,
-                   capthick=None)
-
         Plot *x* versus *y* with error deltas in *yerr* and *xerr*.
         Vertical errorbars are plotted if *yerr* is not *None*.
         Horizontal errorbars are plotted if *xerr* is not *None*.
@@ -3055,16 +2999,6 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
         """
         Make a box and whisker plot.
 
-        Call signature::
-
-          boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
-                  positions=None, widths=None, patch_artist=False,
-                  bootstrap=None, usermedians=None, conf_intervals=None,
-                  meanline=False, showmeans=False, showcaps=True,
-                  showbox=True, showfliers=True, boxprops=None, labels=None,
-                  flierprops=None, medianprops=None, meanprops=None,
-                  capprops=None, whiskerprops=None, manage_xticks=True):
-
         Make a box and whisker plot for each column of *x* or each
         vector in sequence *x*.  The box extends from the lower to
         upper quartile values of the data, with a line at the median.
@@ -3338,15 +3272,6 @@ def bxp(self, bxpstats, positions=None, widths=None, vert=True,
         """
         Drawing function for box and whisker plots.
 
-        Call signature::
-
-          bxp(self, bxpstats, positions=None, widths=None, vert=True,
-              patch_artist=False, shownotches=False, showmeans=False,
-              showcaps=True, showbox=True, showfliers=True,
-              boxprops=None, whiskerprops=None, flierprops=None,
-              medianprops=None, capprops=None, meanprops=None,
-              meanline=False, manage_xticks=True):
-
         Make a box and whisker plot for each column of *x* or each
         vector in sequence *x*.  The box extends from the lower to
         upper quartile values of the data, with a line at the median.
@@ -3950,15 +3875,6 @@ def hexbin(self, x, y, C=None, gridsize=100, bins=None,
         """
         Make a hexagonal binning plot.
 
-        Call signature::
-
-           hexbin(x, y, C = None, gridsize = 100, bins = None,
-                  xscale = 'linear', yscale = 'linear',
-                  cmap=None, norm=None, vmin=None, vmax=None,
-                  alpha=None, linewidths=None, edgecolors='none'
-                  reduce_C_function = np.mean, mincnt=None, marginals=True
-                  **kwargs)
-
         Make a hexagonal binning plot of *x* versus *y*, where *x*,
         *y* are 1-D sequences of the same length, *N*. If *C* is *None*
         (the default), this is a histogram of the number of occurences
@@ -4402,10 +4318,6 @@ def arrow(self, x, y, dx, dy, **kwargs):
         """
         Add an arrow to the axes.
 
-        Call signature::
-
-           arrow(x, y, dx, dy, **kwargs)
-
         Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,
         *y* + *dy*). Uses FancyArrow patch to construct the arrow.
 
@@ -4507,10 +4419,6 @@ def fill(self, *args, **kwargs):
         """
         Plot filled polygons.
 
-        Call signature::
-
-          fill(*args, **kwargs)
-
         *args* is a variable length argument, allowing for multiple
         *x*, *y* pairs with an optional color format string; see
         :func:`~matplotlib.pyplot.plot` for details on the argument
@@ -4716,10 +4624,6 @@ def fill_betweenx(self, y, x1, x2=0, where=None,
         """
         Make filled polygons between two horizontal curves.
 
-        Call signature::
-
-          fill_betweenx(y, x1, x2=0, where=None, **kwargs)
-
         Create a :class:`~matplotlib.collections.PolyCollection`
         filling the regions between *x1* and *x2* where
         ``where==True``
@@ -7258,12 +7162,6 @@ def violinplot(self, dataset, positions=None, vert=True, widths=0.5,
         """
         Make a violin plot.
 
-        Call signature::
-
-          violinplot(dataset, positions=None, vert=True, widths=0.5,
-                     showmeans=False, showextrema=True, showmedians=False,
-                     points=100, bw_method=None):
-
         Make a violin plot for each column of *dataset* or each vector in
         sequence *dataset*.  Each filled area extends to represent the
         entire data range, with optional lines at the mean, the median,
@@ -7361,11 +7259,6 @@ def violin(self, vpstats, positions=None, vert=True, widths=0.5,
                showmeans=False, showextrema=True, showmedians=False):
         """Drawing function for violin plots.
 
-        Call signature::
-
-          violin(vpstats, positions=None, vert=True, widths=0.5,
-                 showmeans=False, showextrema=True, showmedians=False):
-
         Draw a violin plot for each column of `vpstats`. Each filled area
         extends to represent the entire data range, with optional lines at the
         mean, the median, the minimum, and the maximum.
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1158,10 +1158,6 @@ def ishold(self):
 
     def hold(self, b=None):
         """
-        Call signature::
-
-          hold(b=None)
-
         Set the hold state.  If *hold* is *None* (default), toggle the
         *hold* state.  Else set the *hold* state to boolean value *b*.
 
@@ -2458,10 +2454,6 @@ def grid(self, b=None, which='major', axis='both', **kwargs):
         """
         Turn the axes grids on or off.
 
-        Call signature::
-
-           grid(self, b=None, which='major', axis='both', **kwargs)
-
         Set the axes grids on or off; *b* is a boolean.  (For MATLAB
         compatibility, *b* may also be a string, 'on' or 'off'.)
 
@@ -2883,10 +2875,6 @@ def get_xscale(self):
     @docstring.dedent_interpd
     def set_xscale(self, value, **kwargs):
         """
-        Call signature::
-
-          set_xscale(value)
-
         Set the scaling of the x-axis: %(scale)s
 
         ACCEPTS: [%(scale)s]
@@ -2965,10 +2953,6 @@ def get_xticklabels(self, minor=False, which=None):
     @docstring.dedent_interpd
     def set_xticklabels(self, labels, fontdict=None, minor=False, **kwargs):
         """
-        Call signature::
-
-          set_xticklabels(labels, fontdict=None, minor=False, **kwargs)
-
         Set the xtick labels with list of strings *labels*. Return a
         list of axis text instances.
 
@@ -3227,10 +3211,6 @@ def get_yticklabels(self, minor=False, which=None):
     @docstring.dedent_interpd
     def set_yticklabels(self, labels, fontdict=None, minor=False, **kwargs):
         """
-        Call signature::
-
-          set_yticklabels(labels, fontdict=None, minor=False, **kwargs)
-
         Set the y tick labels with list of strings *labels*.  Return a list of
         :class:`~matplotlib.text.Text` instances.
 
@@ -3772,10 +3752,6 @@ def _make_twin_axes(self, *kl, **kwargs):
 
     def twinx(self):
         """
-        Call signature::
-
-          ax = twinx()
-
         create a twin of Axes for generating a plot with a sharex
         x-axis but independent y axis.  The y-axis of self will have
         ticks on left and the returned axes will have ticks on the
@@ -3796,10 +3772,6 @@ def twinx(self):
 
     def twiny(self):
         """
-        Call signature::
-
-          ax = twiny()
-
         create a twin of Axes for generating a plot with a shared
         y-axis but independent x axis.  The x-axis of self will have
         ticks on bottom and the returned axes will have ticks on the
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2424,10 +2424,6 @@ def start_event_loop_default(self, timeout=0):
         functions for each of the GUI backends can be written.  As
         such, it throws a deprecated warning.
 
-        Call signature::
-
-            start_event_loop_default(self,timeout=0)
-
         This call blocks until a callback function triggers
         stop_event_loop() or *timeout* is reached.  If *timeout* is
         <=0, never timeout.
@@ -2452,9 +2448,6 @@ def stop_event_loop_default(self):
         loop so that interactive functions, such as ginput and
         waitforbuttonpress, can wait for events.
 
-        Call signature::
-
-          stop_event_loop_default(self)
         """
         self._looping = False
 
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -765,10 +765,6 @@ def start_event_loop(self, timeout=0):
         confused with the main GUI event loop, which is always running
         and has nothing to do with this.
 
-        Call signature::
-
-        start_event_loop(self,timeout=0)
-
         This call blocks until a callback function triggers
         stop_event_loop() or *timeout* is reached.  If *timeout* is
         <=0, never timeout.
@@ -794,9 +790,6 @@ def stop_event_loop(self, event=None):
         loop so that interactive functions, such as ginput and
         waitforbuttonpress, can wait for events.
 
-        Call signature::
-
-        stop_event_loop_default(self)
         """
         if hasattr(self, '_event_loop'):
             if self._event_loop.IsRunning():
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1629,11 +1629,6 @@ def subplots_adjust(self, *args, **kwargs):
     def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
                mouse_pop=3, mouse_stop=2):
         """
-        Call signature::
-
-          ginput(self, n=1, timeout=30, show_clicks=True,
-                 mouse_add=1, mouse_pop=3, mouse_stop=2)
-
         Blocking call to interact with the figure.
 
         This will wait for *n* clicks from the user and return a list of the
@@ -1668,10 +1663,6 @@ def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
 
     def waitforbuttonpress(self, timeout=-1):
         """
-        Call signature::
-
-          waitforbuttonpress(self, timeout=-1)
-
         Blocking call to interact with the figure.
 
         This will return True is a key was pressed, False if a mouse
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
