From 4d80e7f8bffb1ce8696af77f5531d615cd09e274 Mon Sep 17 00:00:00 2001 From: DoriekeMG Date: Mon, 5 Sep 2016 15:45:19 +0100 Subject: [PATCH 1/3] DOC Replaced documentation with numpydoc for semilogx --- lib/matplotlib/axes/_axes.py | 52 +++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index 0cba4d225e36..5a596cce421f 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -1544,39 +1544,43 @@ def loglog(self, *args, **kwargs): 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`. - - Notable keyword arguments: - - *basex*: scalar > 1 - Base of the *x* logarithm - - *subsx*: [ *None* | sequence ] - The location of the minor xticks; *None* defaults to + + Parameters + ---------- + basex : float, optional + Base of the *x* logarithm. + + subsx : array_like, optional + The location of the minor xticks; *None* defaults to autosubs, which depend on the number of decades in the plot; see :meth:`~matplotlib.axes.Axes.set_xscale` for details. - *nonposx*: [ 'mask' | 'clip' ] - Non-positive values in *x* can be masked as - invalid, or clipped to a very small positive number + nonposx : string, optional, {'mask', 'clip'} + Non-positive values in *x* can be masked as + invalid, or clipped to a very small positive number. - The remaining valid kwargs are + Returns + ------- + `~matplotlib.pyplot.plot` + Log-scaled plot on the *x* axis. + + Other Parameters + ---------------- :class:`~matplotlib.lines.Line2D` properties: %(Line2D)s + + See Also + -------- + loglog : For example code and figure. + + Notes + ----- + *This function supports all the keyword arguments of + :func:`~matplotlib.pyplot.plot` and + :meth:`matplotlib.axes.Axes.set_xscale`. - .. seealso:: - - :meth:`loglog` - For example code and figure """ if not self._hold: self.cla() From f8035a3285618cbc6e09156c3bd76a2b1460cd0b Mon Sep 17 00:00:00 2001 From: DoriekeMG Date: Mon, 5 Sep 2016 18:59:32 +0100 Subject: [PATCH 2/3] DOC Replaced tabs with spaces --- lib/matplotlib/axes/_axes.py | 40 ++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index 5a596cce421f..ca70e215d106 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -1544,40 +1544,40 @@ def loglog(self, *args, **kwargs): def semilogx(self, *args, **kwargs): """ Make a plot with log scaling on the *x* axis. - - Parameters - ---------- - basex : float, optional - Base of the *x* logarithm. + + Parameters + ---------- + basex : float, optional + Base of the *x* logarithm. - subsx : array_like, optional - The location of the minor xticks; *None* defaults to + subsx : array_like, optional + The location of the minor xticks; *None* defaults to autosubs, which depend on the number of decades in the plot; see :meth:`~matplotlib.axes.Axes.set_xscale` for details. - nonposx : string, optional, {'mask', 'clip'} - Non-positive values in *x* can be masked as + nonposx : string, optional, {'mask', 'clip'} + Non-positive values in *x* can be masked as invalid, or clipped to a very small positive number. - Returns - ------- - `~matplotlib.pyplot.plot` - Log-scaled plot on the *x* axis. + Returns + ------- + `~matplotlib.pyplot.plot` + Log-scaled plot on the *x* axis. - Other Parameters + Other Parameters ---------------- :class:`~matplotlib.lines.Line2D` properties: %(Line2D)s - See Also - -------- - loglog : For example code and figure. + See Also + -------- + loglog : For example code and figure. - Notes - ----- - *This function supports all the keyword arguments of + Notes + ----- + *This function supports all the keyword arguments of :func:`~matplotlib.pyplot.plot` and :meth:`matplotlib.axes.Axes.set_xscale`. From eb12a6c087c28fd2e2c75a05cf6a7a6b9e40aad1 Mon Sep 17 00:00:00 2001 From: DoriekeMG Date: Wed, 7 Sep 2016 18:35:04 +0100 Subject: [PATCH 3/3] DOC Removed spaces on empty lines and mixed spaced and tabs --- lib/matplotlib/axes/_axes.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index ca70e215d106..da0bec3deed4 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -1544,11 +1544,12 @@ def loglog(self, *args, **kwargs): def semilogx(self, *args, **kwargs): """ Make a plot with log scaling on the *x* axis. - + Parameters ---------- basex : float, optional - Base of the *x* logarithm. + Base of the *x* logarithm. The scalar should be larger + than 1. subsx : array_like, optional The location of the minor xticks; *None* defaults to @@ -1570,14 +1571,14 @@ def semilogx(self, *args, **kwargs): :class:`~matplotlib.lines.Line2D` properties: %(Line2D)s - + See Also -------- loglog : For example code and figure. Notes ----- - *This function supports all the keyword arguments of + This function supports all the keyword arguments of :func:`~matplotlib.pyplot.plot` and :meth:`matplotlib.axes.Axes.set_xscale`.