diff --git a/.travis.yml b/.travis.yml index bb43b9ae0a5a..939b10cace36 100644 --- a/.travis.yml +++ b/.travis.yml @@ -100,7 +100,7 @@ install: # Neihter is installed as a dependency of IPython since they are not used by the IPython console. - | if [[ $BUILD_DOCS == true ]]; then - pip install $PRE numpydoc ipython jsonschema mistune colorspacious + pip install $PRE ipython jsonschema mistune colorspacious pip install -q $PRE linkchecker wget https://github.com/google/fonts/blob/master/ofl/felipa/Felipa-Regular.ttf?raw=true -O Felipa-Regular.ttf wget http://mirrors.kernel.org/ubuntu/pool/universe/f/fonts-humor-sans/fonts-humor-sans_1.0-1_all.deb diff --git a/doc/README.txt b/doc/README.txt index 51c4b9093edd..0a614e03fa97 100644 --- a/doc/README.txt +++ b/doc/README.txt @@ -33,11 +33,10 @@ python documentation system built on top of ReST. This directory contains * mpl_examples - a link to the matplotlib examples in case any documentation wants to literal include them -To build the HTML documentation, install sphinx (1.0 or greater -required), then type "python make.py html" in this directory. Wait -for the initial run (which builds the example gallery) to be done, -then run "python make.py html" again. The top file of the results will -be ./build/html/index.html +To build the HTML documentation, install sphinx (1.0 or greater required) and, +if sphinx older than 1.3, sphinxcontrib-napoleon, then type "python make.py +html" in this directory. The top file of the results will be +./build/html/index.html Note that Sphinx uses the installed version of the package to build the documentation, so matplotlib must be installed *before* the docs diff --git a/doc/conf.py b/doc/conf.py index d92366401287..09a26f4c0dea 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -32,7 +32,11 @@ 'sphinx.ext.inheritance_diagram', 'sphinxext.gen_gallery', 'sphinxext.gen_rst', 'sphinxext.github', - 'numpydoc'] + ] +if hasattr(sphinx, 'version_info') and sphinx.version_info[:2] >= (1, 3): + extensions += ['sphinx.ext.napoleon'] +else: + extensions += ['sphinxcontrib.napoleon'] exclude_patterns = ['api/api_changes/*', 'users/whats_new/*'] @@ -46,12 +50,6 @@ extensions.append('IPython.sphinxext.ipython_console_highlighting') extensions.append('IPython.sphinxext.ipython_directive') -try: - import numpydoc -except ImportError: - raise ImportError("No module named numpydoc - you need to install " - "numpydoc to build the documentation.") - autosummary_generate = True @@ -333,5 +331,6 @@ def getapi(*args): sys.modules['sip'] = mocksip sys.modules['PyQt4'] = mockpyqt4 -################# numpydoc config #################### -numpydoc_show_class_members = False +################# napoleon config #################### +napoleon_google_docstring = False +napoleon_use_param = False diff --git a/doc/make.py b/doc/make.py index 1139370d10d2..6180a1633752 100755 --- a/doc/make.py +++ b/doc/make.py @@ -60,7 +60,7 @@ def htmlhelp(): with open('build/htmlhelp/index.html', 'r+') as fh: content = fh.read() fh.seek(0) - content = re.sub(r'', '', content, + content = re.sub(r'', '', content, flags=re.MULTILINE| re.DOTALL) fh.write(content) fh.truncate() diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py index e8ec00cd51ff..6a60de2fb3de 100644 --- a/lib/matplotlib/artist.py +++ b/lib/matplotlib/artist.py @@ -427,10 +427,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 """ @@ -573,17 +569,17 @@ def get_sketch_params(self): ------- sketch_params : tuple or `None` - A 3-tuple with the following elements: + A 3-tuple with the following elements: - * `scale`: The amplitude of the wiggle perpendicular to the - source line. + * `scale`: The amplitude of the wiggle perpendicular to the + source line. - * `length`: The length of the wiggle along the line. + * `length`: The length of the wiggle along the line. - * `randomness`: The scale factor by which the length is - shrunken or expanded. + * `randomness`: The scale factor by which the length is + shrunken or expanded. - May return `None` if no sketch parameters were set. + May return `None` if no sketch parameters were set. """ return self._sketch diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index a0f6e7fc1c15..6c032d1ba959 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -775,7 +775,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs): Examples - --------- + -------- * draw a thick red vline at *x* = 0 that spans the yrange:: >>> axvline(linewidth=4, color='r') @@ -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. @@ -1044,7 +1036,7 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid', hlines : horizontal lines Examples - --------- + -------- .. plot:: mpl_examples/pylab_examples/vline_hline_demo.py """ @@ -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`. @@ -1701,16 +1670,17 @@ def acorr(self, x, **kwargs): Returns ------- - (lags, c, line, b) : where: - - - `lags` are a length 2`maxlags+1 lag vector. - - `c` is the 2`maxlags+1 auto correlation vectorI - - `line` is a `~matplotlib.lines.Line2D` instance returned by - `plot`. - - `b` is the x-axis. + lags + a length 2`maxlags+1 lag vector + c + the 2`maxlags+1 auto correlation vectorI + line + a `~matplotlib.lines.Line2D` instance returned by `plot` + b + the x-axis Other parameters - ----------------- + ---------------- linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None Only used if usevlines is False. @@ -1766,16 +1736,17 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none, Returns ------- - (lags, c, line, b) : where: - - - `lags` are a length 2`maxlags+1 lag vector. - - `c` is the 2`maxlags+1 auto correlation vectorI - - `line` is a `~matplotlib.lines.Line2D` instance returned by - `plot`. - - `b` is the x-axis (none, if plot is used). + lags + a length 2`maxlags+1 lag vector + c + the 2`maxlags+1 auto correlation vectorI + line + a `~matplotlib.lines.Line2D` instance returned by `plot` + b + the x-axis (none, if plot is used) Other parameters - ----------------- + ---------------- linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None Only used if usevlines is False. @@ -1827,10 +1798,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`. @@ -2228,7 +2195,7 @@ def barh(self, bottom, width, height=0.8, left=None, **kwargs): the x coordinates of the left sides of the bars Returns - -------- + ------- `matplotlib.patches.Rectangle` instances. Other parameters @@ -2301,10 +2268,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 +2417,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 +2630,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*. @@ -3056,17 +3002,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): - 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. @@ -3345,15 +3280,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. @@ -3963,15 +3889,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 @@ -4415,10 +4332,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. @@ -4520,10 +4433,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 @@ -4729,10 +4638,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`` @@ -4857,7 +4762,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None, Display an image on the axes. Parameters - ----------- + ---------- X : array_like, shape (n, m) or (n, m, 3) or (n, m, 4) Display the image in `X` to current axes. `X` may be a float array, a uint8 array or a PIL image. If `X` is an array, it @@ -4937,7 +4842,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None, when interpolation is one of: 'sinc', 'lanczos' or 'blackman' Returns - -------- + ------- image : `~matplotlib.image.AxesImage` Other parameters @@ -6348,7 +6253,7 @@ def hist2d(self, x, y, bins=10, range=None, normed=False, weights=None, The return value is ``(counts, xedges, yedges, Image)``. Other parameters - ----------------- + ---------------- kwargs : :meth:`pcolorfast` properties. See also @@ -7268,13 +7173,8 @@ def matshow(self, Z, **kwargs): def violinplot(self, dataset, positions=None, vert=True, widths=0.5, showmeans=False, showextrema=True, showmedians=False, points=100, bw_method=None): - """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. Make a violin plot for each column of *dataset* or each vector in sequence *dataset*. Each filled area extends to represent the @@ -7373,11 +7273,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 index 16138d25f248..ea86c1eb265a 100644 --- a/lib/matplotlib/axes/_base.py +++ b/lib/matplotlib/axes/_base.py @@ -1164,10 +1164,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*. @@ -2421,10 +2417,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'.) @@ -2841,10 +2833,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] @@ -2923,10 +2911,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. @@ -3185,10 +3169,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. @@ -3730,10 +3710,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 @@ -3754,10 +3730,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 index 78e5de56851d..9ed60c681b1e 100644 --- a/lib/matplotlib/backend_bases.py +++ b/lib/matplotlib/backend_bases.py @@ -1119,17 +1119,17 @@ def get_sketch_params(self): ------- sketch_params : tuple or `None` - A 3-tuple with the following elements: + A 3-tuple with the following elements: - * `scale`: The amplitude of the wiggle perpendicular to the - source line. + * `scale`: The amplitude of the wiggle perpendicular to the + source line. - * `length`: The length of the wiggle along the line. + * `length`: The length of the wiggle along the line. - * `randomness`: The scale factor by which the length is - shrunken or expanded. + * `randomness`: The scale factor by which the length is + shrunken or expanded. - May return `None` if no sketch parameters were set. + May return `None` if no sketch parameters were set. """ return self._sketch @@ -2430,10 +2430,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. @@ -2458,9 +2454,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/backend_managers.py b/lib/matplotlib/backend_managers.py index e21e12f982e3..8608bc77b173 100644 --- a/lib/matplotlib/backend_managers.py +++ b/lib/matplotlib/backend_managers.py @@ -79,7 +79,7 @@ def toolmanager_connect(self, s, func): Connect event with string *s* to *func*. Parameters - ----------- + ---------- s : String Name of the event @@ -138,7 +138,7 @@ def get_tool_keymap(self, name): Name of the Tool Returns - ---------- + ------- list : list of keys associated with the Tool """ @@ -379,7 +379,7 @@ def get_tool(self, name, warn=True): Return the tool object, also accepts the actual tool for convenience Parameters - ----------- + ---------- name : str, ToolBase Name of the tool, or the tool itself warn : bool, optional diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py index 74721528ac09..8227df7f9064 100644 --- a/lib/matplotlib/backends/backend_wx.py +++ b/lib/matplotlib/backends/backend_wx.py @@ -763,10 +763,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. @@ -792,9 +788,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/cbook.py b/lib/matplotlib/cbook.py index a43971c5a169..ca03d34267aa 100644 --- a/lib/matplotlib/cbook.py +++ b/lib/matplotlib/cbook.py @@ -86,7 +86,7 @@ def warn_deprecated( Used to display deprecation warning in a standard way. Parameters - ------------ + ---------- since : str The release at which this API became deprecated. @@ -143,7 +143,7 @@ def deprecated(since, message='', name='', alternative='', pending=False, Decorator to mark a function as deprecated. Parameters - ------------ + ---------- since : str The release at which this API became deprecated. This is required. @@ -599,7 +599,7 @@ def local_over_kwdict(local_var, kwargs, *keys): kwargs dict in place. Parameters - ------------ + ---------- local_var: any object The local variable (highest priority) @@ -611,12 +611,12 @@ def local_over_kwdict(local_var, kwargs, *keys): priority Returns - --------- + ------- out: any object Either local_var or one of kwargs[key] for key in keys Raises - -------- + ------ IgnoredKeywordWarning For each key in keys that is removed from kwargs but not used as the output value diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py index ad6a145a9d12..85e202dabefc 100644 --- a/lib/matplotlib/colorbar.py +++ b/lib/matplotlib/colorbar.py @@ -1022,9 +1022,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): @@ -1158,9 +1156,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): diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py index 27c72b01b2d3..6df2c0d6fa13 100644 --- a/lib/matplotlib/figure.py +++ b/lib/matplotlib/figure.py @@ -1597,11 +1597,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 @@ -1636,10 +1631,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/lines.py b/lib/matplotlib/lines.py index adccfc3a8cda..8e397e5e1040 100644 --- a/lib/matplotlib/lines.py +++ b/lib/matplotlib/lines.py @@ -1090,7 +1090,7 @@ def set_marker(self, marker): ACCEPTS: :mod:`A valid marker style ` Parameters - ----------- + ---------- marker: marker style See `~matplotlib.markers` for full description of possible diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py index d6b99427b9e7..73d1083d7f76 100644 --- a/lib/matplotlib/mlab.py +++ b/lib/matplotlib/mlab.py @@ -4,7 +4,7 @@ commands with the same names. MATLAB compatible functions -------------------------------- +--------------------------- :func:`cohere` Coherence (normalized cross spectral density) @@ -39,7 +39,7 @@ Spectrogram (spectrum over segments of time) Miscellaneous functions -------------------------- +----------------------- Functions that don't exist in MATLAB, but are useful anyway: @@ -99,7 +99,7 @@ record array helper functions -------------------------------- +----------------------------- A collection of helper methods for numpyrecord arrays @@ -192,9 +192,6 @@ def logspace(xmin, xmax, N): ''' Return N values logarithmically spaced between xmin and xmax. - Call signature:: - - logspace(xmin, xmax, N) ''' return np.exp(np.linspace(np.log(xmin), np.log(xmax), N)) @@ -203,9 +200,6 @@ def _norm(x): ''' Return sqrt(x dot x). - Call signature:: - - _norm(x) ''' return np.sqrt(np.dot(x, x)) @@ -214,10 +208,6 @@ def window_hanning(x): ''' Return x times the hanning window of len(x). - Call signature:: - - window_hanning(x) - .. seealso:: :func:`window_none` @@ -230,10 +220,6 @@ def window_none(x): ''' No window function; simply return x. - Call signature:: - - window_none(x) - .. seealso:: :func:`window_hanning` @@ -246,10 +232,6 @@ def apply_window(x, window, axis=0, return_window=None): ''' Apply the given window to the given 1D or 2D array along the given axis. - Call signature:: - - apply_window(x, window, axis=0, return_window=False) - *x*: 1D or 2D array or sequence Array or sequence containing the data. @@ -304,10 +286,6 @@ def detrend(x, key=None, axis=None): ''' Return x with its trend removed. - Call signature:: - - detrend(x, key='mean') - *x*: array or sequence Array or sequence containing the data. @@ -369,10 +347,6 @@ def demean(x, axis=0): ''' Return x minus its mean along the specified axis. - Call signature:: - - demean(x, axis=0) - *x*: array or sequence Array or sequence containing the data Can have any dimensionality @@ -399,10 +373,6 @@ def detrend_mean(x, axis=None): ''' Return x minus the mean(x). - Call signature:: - - detrend_mean(x, axis=None) - *x*: array or sequence Array or sequence containing the data Can have any dimensionality @@ -448,10 +418,6 @@ def detrend_none(x, axis=None): ''' Return x: no detrending. - Call signature:: - - detrend_none(x, axis=None) - *x*: any object An object containing the data @@ -481,10 +447,6 @@ def detrend_linear(y): ''' Return x minus best fit line; 'linear' detrending. - Call signature:: - - detrend_linear(y) - *y*: 0-D or 1-D array or sequence Array or sequence containing the data @@ -537,10 +499,6 @@ def stride_windows(x, n, noverlap=None, axis=0): elements may point to the same piece of memory, so modifying one value may change others. - Call signature:: - - stride_windows(x, n, noverlap=0) - *x*: 1D array or sequence Array or sequence containing the data. @@ -606,10 +564,6 @@ def stride_repeat(x, n, axis=0): elements may point to the same piece of memory, so modifying one value may change others. - Call signature:: - - stride_repeat(x, n, axis=0) - *x*: 1D array or sequence Array or sequence containing the data. @@ -1394,10 +1348,6 @@ def cohere_pairs(X, ij, NFFT=256, Fs=2, detrend=detrend_none, returnPxx=False): """ - Call signature:: - - Cxy, Phase, freqs = cohere_pairs( X, ij, ...) - Compute the coherence and phase for all pairs *ij*, in *X*. *X* is a *numSamples* * *numCols* array @@ -3654,9 +3604,6 @@ class GaussianKDE(object): """ Representation of a kernel-density estimate using Gaussian kernels. - Call signature:: - kde = GaussianKDE(dataset, bw_method='silverman') - Parameters ---------- dataset : array_like diff --git a/lib/matplotlib/patheffects.py b/lib/matplotlib/patheffects.py index 5435bcc8bd00..e73f8aeb0ff4 100644 --- a/lib/matplotlib/patheffects.py +++ b/lib/matplotlib/patheffects.py @@ -231,7 +231,7 @@ def __init__(self, offset=(2, -2), rho : float A scale factor to apply to the rgbFace color if `shadow_rgbFace` is not specified. Default is 0.3. - **kwargs + \\*\\*kwargs Extra keywords are stored and passed through to :meth:`AbstractPathEffect._update_gc`. @@ -313,7 +313,7 @@ def __init__(self, offset=(2,-2), rho : float A scale factor to apply to the rgbFace color if `shadow_rgbFace` is ``None``. Default is 0.3. - **kwargs + \\*\\*kwargs Extra keywords are stored and passed through to :meth:`AbstractPathEffect._update_gc`. @@ -374,7 +374,7 @@ def __init__(self, offset=(0, 0), **kwargs): ---------- offset : pair of floats The offset to apply to the path, in points. - **kwargs : + \\*\\*kwargs All keyword arguments are passed through to the :class:`~matplotlib.patches.PathPatch` constructor. The properties which cannot be overridden are "path", "clip_box" diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py index 9b1d8a700abc..ad72a19165b6 100644 --- a/lib/matplotlib/pyplot.py +++ b/lib/matplotlib/pyplot.py @@ -912,7 +912,7 @@ def gca(**kwargs): current figure matching the given keyword args, or create one. Examples - --------- + -------- To get the current polar axes on the current figure:: plt.gca(projection='polar') diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py index 242c5d9b34b5..d85542ec83d1 100644 --- a/lib/matplotlib/testing/decorators.py +++ b/lib/matplotlib/testing/decorators.py @@ -270,10 +270,6 @@ def image_comparison(baseline_images=None, extensions=None, tol=0, freetype_version=None, remove_text=False, savefig_kwarg=None, style='classic'): """ - call signature:: - - image_comparison(baseline_images=['my_figure'], extensions=None) - Compare images generated by the test with those specified in *baseline_images*, which must correspond else an ImageComparisonFailure exception will be raised. diff --git a/lib/matplotlib/tri/triinterpolate.py b/lib/matplotlib/tri/triinterpolate.py index 8eb01f13a85e..803ec73ac08e 100644 --- a/lib/matplotlib/tri/triinterpolate.py +++ b/lib/matplotlib/tri/triinterpolate.py @@ -1334,14 +1334,14 @@ def _cg(A, b, x0=None, tol=1.e-10, maxiter=1000): Right hand side of the linear system. Returns - ---------- + ------- x: array. The converged solution. err: float The absolute error np.linalg.norm(A.dot(x) - b) Other parameters - ---------- + ---------------- x0: array. Starting guess for the solution. tol: float. diff --git a/lib/mpl_toolkits/axes_grid1/anchored_artists.py b/lib/mpl_toolkits/axes_grid1/anchored_artists.py index fd02370f230b..66bee5b975a4 100644 --- a/lib/mpl_toolkits/axes_grid1/anchored_artists.py +++ b/lib/mpl_toolkits/axes_grid1/anchored_artists.py @@ -76,8 +76,8 @@ def __init__(self, transform, size, label, loc, Draw a horizontal bar with the size in data coordinate of the given axes. A label will be drawn underneath (center-aligned). - Parameters: - ----------- + Parameters + ---------- transform : matplotlib transformation object size : int or float horizontal length of the size bar, given in data coordinates @@ -100,12 +100,12 @@ def __init__(self, transform, size, label, loc, fontproperties: a matplotlib.font_manager.FontProperties instance, optional sets the font properties for the label text - Returns: - -------- + Returns + ------- AnchoredSizeBar object - Example: - -------- + Example + ------- >>> import matplotlib.pyplot as plt >>> import numpy as np >>> from mpl_toolkits.axes_grid1.anchored_artists import AnchoredSizeBar diff --git a/lib/mpl_toolkits/axes_grid1/inset_locator.py b/lib/mpl_toolkits/axes_grid1/inset_locator.py index 65c96d082d8c..73b71aa01751 100644 --- a/lib/mpl_toolkits/axes_grid1/inset_locator.py +++ b/lib/mpl_toolkits/axes_grid1/inset_locator.py @@ -158,7 +158,7 @@ def __init__(self, bbox, **kwargs): bbox : `matplotlib.transforms.Bbox` Bbox to use for the extents of this patch. - **kwargs + \\*\\*kwargs Patch properties. Valid arguments include: %(Patch)s """ @@ -304,7 +304,7 @@ def __init__(self, bbox1, bbox2, loc1, loc2=None, **kwargs): 'lower left' : 3, 'lower right' : 4 - **kwargs + \\*\\*kwargs Patch properties for the line drawn. Valid arguments include: %(Patch)s """ @@ -358,7 +358,7 @@ def __init__(self, bbox1, bbox2, loc1a, loc2a, loc1b, loc2b, **kwargs): 'lower left' : 3, 'lower right' : 4 - **kwargs + \\*\\*kwargs Patch properties for the line drawn: %(Patch)s """ @@ -568,7 +568,7 @@ def mark_inset(parent_axes, inset_axes, loc1, loc2, **kwargs): Corners to use for connecting the inset axes and the area in the parent axes. - **kwargs + \\*\\*kwargs Patch properties for the lines and box drawn: %(Patch)s