Fix bug: [ 1978629 ] scale documentation missing/incorrect for log

mdboom · mdboom · commit 424adc1a14ab · 2008-06-20T15:24:16.000Z
svn path=/trunk/matplotlib/; revision=5616
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,5 @@
+2008-06-20 [ 1978629 ] scale documentation missing/incorrect for log - MGD
+
 2008-06-20 Added closed kwarg to PolyCollection.  Fixes bug [ 1994535
            ] still missing lines on graph with svn (r 5548). - MGD
 
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -1765,12 +1765,15 @@ def set_xscale(self, value, **kwargs):
 
         Different kwargs are accepted, depending on the scale:
         %(scale_docs)s
-        """ % {'scale': ' | '.join([repr(x) for x in mscale.get_scale_names()]),
-               'scale_docs': mscale.get_scale_docs().strip()}
+        """
         self.xaxis.set_scale(value, **kwargs)
         self.autoscale_view()
         self._update_transScale()
 
+    set_xscale.__doc__ = cbook.dedent(set_xscale.__doc__) % {
+        'scale': ' | '.join([repr(x) for x in mscale.get_scale_names()]),
+        'scale_docs': mscale.get_scale_docs().strip()}
+
     def get_xticks(self, minor=False):
         'Return the x ticks as a list of locations'
         return self.xaxis.get_ticklocs(minor=minor)
@@ -1929,12 +1932,15 @@ def set_yscale(self, value, **kwargs):
 
         Different kwargs are accepted, depending on the scale:
         %(scale_docs)s
-        """ % {'scale': ' | '.join([repr(x) for x in mscale.get_scale_names()]),
-               'scale_docs': mscale.get_scale_docs().strip()}
+        """
         self.yaxis.set_scale(value, **kwargs)
         self.autoscale_view()
         self._update_transScale()
 
+    set_yscale.__doc__ = cbook.dedent(set_yscale.__doc__) % {
+        'scale': ' | '.join([repr(x) for x in mscale.get_scale_names()]),
+        'scale_docs': mscale.get_scale_docs().strip()}
+
     def get_yticks(self, minor=False):
         'Return the y ticks as a list of locations'
         return self.yaxis.get_ticklocs(minor=minor)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -810,33 +810,43 @@ def ylim(*args, **kwargs):
 
 def xscale(*args, **kwargs):
     """
+    call signature::
+
+      xscale(scale, **kwargs)
+
     Set the scaling for the x-axis: %(scale)s
 
     Different keywords may be accepted, depending on the scale:
 
     %(scale_docs)s
-    """ % {'scale': ' | '.join([repr(x) for x in get_scale_names()]),
-           'scale_docs': get_scale_docs()}
+    """
     ax = gca()
     ret = ax.set_xscale(*args, **kwargs)
     draw_if_interactive()
     return ret
-
+xscale.__doc__ = dedent(xscale.__doc__) % {
+    'scale': ' | '.join([repr(x) for x in get_scale_names()]),
+    'scale_docs': get_scale_docs()}
 
 def yscale(*args, **kwargs):
     """
+    call signature::
+
+      xscale(scale, **kwargs)
+
     Set the scaling for the y-axis: %(scale)s
 
     Different keywords may be accepted, depending on the scale:
 
     %(scale_docs)s
-    """ % {'scale': ' | '.join([repr(x) for x in get_scale_names()]),
-           'scale_docs': get_scale_docs()}
+    """
     ax = gca()
     ret = ax.set_yscale(*args, **kwargs)
     draw_if_interactive()
     return ret
-
+yscale.__doc__ = dedent(yscale.__doc__) % {
+    'scale': ' | '.join([repr(x) for x in get_scale_names()]),
+    'scale_docs': get_scale_docs()}
 
 def xticks(*args, **kwargs):
     """
diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
@@ -172,10 +172,18 @@ def inverted(self):
 
     def __init__(self, axis, **kwargs):
         """
-        basex/basey: The base of the logarithm
+        *basex*/*basey*:
+           The base of the logarithm
 
-        subsx/subsy: The number of subticks to draw between each major
-        tick
+        *subsx*/*subsy*:
+           Where to place the subticks between each major tick.
+           Should be a sequence of integers.  For example, in a log10
+           scale::
+
+             [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+           will place 10 logarithmically spaced minor ticks between
+           each major tick.
         """
         if axis.axis_name == 'x':
             base = kwargs.pop('basex', 10.0)
@@ -273,14 +281,22 @@ def inverted(self):
 
     def __init__(self, axis, **kwargs):
         """
-        basex/basey: The base of the logarithm
+        *basex*/*basey*:
+           The base of the logarithm
+
+        *linthreshx*/*linthreshy*:
+          The range (-*x*, *x*) within which the plot is linear (to
+          avoid having the plot go to infinity around zero).
+
+        *subsx*/*subsy*:
+           Where to place the subticks between each major tick.
+           Should be a sequence of integers.  For example, in a log10
+           scale::
 
-        linthreshx/linthreshy: The range (-x, x) within which the plot
-        is linear (to avoid having the plot go to infinity around
-        zero).
+             [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
 
-        subsx/subsy: The number of subticks to render between each
-        major tick.
+           will place 10 logarithmically spaced minor ticks between
+           each major tick.
         """
         if axis.axis_name == 'x':
             base = kwargs.pop('basex', 10.0)
@@ -340,9 +356,8 @@ def get_scale_docs():
         scale_class = _scale_mapping[name]
         docs.append("    '%s'" % name)
         docs.append("")
-        class_docs = textwrap.wrap(
-            dedent(scale_class.__init__.__doc__), initial_indent=" " * 8,
-            subsequent_indent = " " * 8)
-        docs.extend(class_docs)
+        class_docs = dedent(scale_class.__init__.__doc__)
+        class_docs = "".join(["        %s\n" % x for x in class_docs.split("\n")])
+        docs.append(class_docs)
         docs.append("")
     return "\n".join(docs)

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+2008-06-20 [ 1978629 ] scale documentation missing/incorrect for log - MGD`
	`2`	`+`
`1`	`3`	`2008-06-20 Added closed kwarg to PolyCollection. Fixes bug [ 1994535`
`2`	`4`	`] still missing lines on graph with svn (r 5548). - MGD`
`3`	`5`