DOC: Remove redundant call signatures.

Author: QuLogic

lib/matplotlib/artist.py

@@ -426,11 +426,8 @@ def pickable(self):
                 self._picker is not None)
 
     def pick(self, mouseevent):
-        """Process pick event
-
-        call signature::
-
-          pick(mouseevent)
+        """
+        Process pick event
 
         each child artist will fire a pick event if *mouseevent* is over
         the artist and the artist has picker set

lib/matplotlib/axes/_axes.py

@@ -1089,12 +1089,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.
@@ -1497,10 +1491,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` /
@@ -2304,10 +2294,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*.
 
@@ -2494,15 +2480,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=None,
-              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
@@ -3111,17 +3088,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, autorange=False, zorder=None):
-
         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.
@@ -3421,15 +3387,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, zorder=None):
-
         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.
@@ -4900,10 +4857,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``
@@ -7066,12 +7019,6 @@ def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
         """
         Plot the coherence between *x* and *y*.
 
-        Call signature::
-
-          cohere(x, y, NFFT=256, Fs=2, Fc=0, detrend = mlab.detrend_none,
-                 window = mlab.window_hanning, noverlap=0, pad_to=None,
-                 sides='default', scale_by_freq=None, **kwargs)
-
         Plot the coherence between *x* and *y*.  Coherence is the
         normalized cross spectral density:
 
@@ -7451,12 +7398,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,
@@ -7554,11 +7495,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.

lib/matplotlib/axes/_base.py

@@ -1189,11 +1189,8 @@ def ishold(self):
         return self._hold
 
     def hold(self, b=None):
-        """Set the hold state
-
-        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*.
@@ -2454,10 +2451,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'.)
 
@@ -2788,12 +2781,7 @@ def get_xlim(self):
         return tuple(self.viewLim.intervalx)
 
     def set_xlim(self, left=None, right=None, emit=True, auto=False, **kw):
-        """Set the data limits for the xaxis
-
-        Call signature::
-
-          set_xlim(self, *args, **kwargs):
-
+        """
         Set the data limits for the xaxis
 
         Examples::
@@ -2887,11 +2875,8 @@ def get_xscale(self):
 
     @docstring.dedent_interpd
     def set_xscale(self, value, **kwargs):
-        """Set the x-axis scale
-
-        Call signature::
-
-          set_xscale(value)
+        """
+        Set the x-axis scale
 
         Set the scaling of the x-axis: %(scale)s
 
@@ -2970,14 +2955,10 @@ def get_xticklabels(self, minor=False, which=None):
 
     @docstring.dedent_interpd
     def set_xticklabels(self, labels, fontdict=None, minor=False, **kwargs):
-        """Set the xtick labels with list of strings *labels*
-
-        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.
+        Return a list of axis text instances.
 
         *kwargs* set the :class:`~matplotlib.text.Text` properties.
         Valid properties are
@@ -3049,11 +3030,8 @@ def get_ylim(self):
         return tuple(self.viewLim.intervaly)
 
     def set_ylim(self, bottom=None, top=None, emit=True, auto=False, **kw):
-        """Set the data limits for the yaxis
-
-        Call signature::
-
-          set_ylim(self, *args, **kwargs):
+        """
+        Set the data limits for the yaxis
 
         Examples::
 
@@ -3149,10 +3127,6 @@ def get_yscale(self):
     def set_yscale(self, value, **kwargs):
         """Set the y-axis scale
 
-        Call signature::
-
-          set_yscale(value)
-
         Set the scaling of the y-axis: %(scale)s
 
         ACCEPTS: [%(scale)s]
@@ -3233,14 +3207,10 @@ def get_yticklabels(self, minor=False, which=None):
 
     @docstring.dedent_interpd
     def set_yticklabels(self, labels, fontdict=None, minor=False, **kwargs):
-        """Set the y tick labels with list of strings *labels*
-
-        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.
+        Return a list of :class:`~matplotlib.text.Text` instances.
 
         *kwargs* set :class:`~matplotlib.text.Text` properties for the labels.
         Valid properties are
@@ -3781,11 +3751,8 @@ def _make_twin_axes(self, *kl, **kwargs):
         return ax2
 
     def twinx(self):
-        """Create a twin Axes sharing the xaxis
-
-        Call signature::
-
-          ax = twinx()
+        """
+        Create a twin Axes sharing the xaxis
 
         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
@@ -3807,11 +3774,8 @@ def twinx(self):
         return ax2
 
     def twiny(self):
-        """Create a twin Axes sharing the yaxis
-
-        Call signature::
-
-          ax = twiny()
+        """
+        Create a twin Axes sharing the yaxis
 
         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

lib/matplotlib/backend_bases.py

@@ -2429,10 +2429,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.
@@ -2457,9 +2453,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
 

lib/matplotlib/backends/backend_wx.py

@@ -770,10 +770,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.
@@ -799,9 +795,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():

lib/matplotlib/colorbar.py

@@ -1025,9 +1025,7 @@ def make_axes(parents, location=None, orientation=None, fraction=0.15,
               shrink=1.0, aspect=20, **kw):
     '''
     Resize and reposition parent axes, and return a child
-    axes suitable for a colorbar::
-
-        cax, kw = make_axes(parent, **kw)
+    axes suitable for a colorbar.
 
     Keyword arguments may include the following (with defaults):
 
@@ -1161,9 +1159,7 @@ def make_axes_gridspec(parent, **kw):
         of the parent with a new one.
 
     While this function is meant to be compatible with *make_axes*,
-    there could be some minor differences.::
-
-        cax, kw = make_axes_gridspec(parent, **kw)
+    there could be some minor differences.
 
     Keyword arguments may include the following (with defaults):
 

lib/matplotlib/contour.py

@@ -1335,11 +1335,6 @@ def find_nearest_contour(self, x, y, indices=None, pixel=True):
         Returns a tuple containing the contour, segment, index of
         segment, x & y of segment point and distance to minimum point.
 
-        Call signature::
-
-          conmin,segmin,imin,xmin,ymin,dmin = find_nearest_contour(
-                     self, x, y, indices=None, pixel=True )
-
         Optional keyword arguments:
 
           *indices*:

lib/matplotlib/figure.py

@@ -1627,11 +1627,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
@@ -1666,10 +1661,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