added ticker api docs

jdh2358 · jdh2358 · commit b14af91eceac · 2008-10-22T18:45:10.000Z
svn path=/trunk/matplotlib/; revision=6297
diff --git a/API_CHANGES b/API_CHANGES
@@ -1,8 +1,8 @@
 Changes for 0.98.x
 ==================
 
-* Restored 0.91 behavior of get_xlim/ylim returning a tuple
-  rather than array - JDH
+* set_xlim, ylim now return a copy of the viewlim array to
+  avoid modify inplace surprises
 
 * AFM.get_fullname() and get_familyname() no longer raise an
   exception if the AFM file does not specify these optional attributes,
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,5 @@
-2008-10-21 Restored 0.91 behavior of get_xlim/ylim returning a tuple
-           rather than array - JDH
+2008-10-21 set_xlim, ylim now return a copy of the viewlim array to
+           avoid modify inplace surprises
 
 2008-10-20 Added image thumbnail generating function
            matplotlib.image.thumbnail.  See
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -26,4 +26,5 @@
    mlab_api.rst
    path_api.rst
    pyplot_api.rst
+   ticker_api.rst
    index_backend_api.rst
diff --git a/doc/api/ticker_api.rst b/doc/api/ticker_api.rst
@@ -0,0 +1,12 @@
+*******************
+matplotlib ticker
+*******************
+
+
+:mod:`matplotlib.ticker`
+==========================
+
+.. automodule:: matplotlib.ticker
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/utils/pylab_names.py b/doc/utils/pylab_names.py
@@ -0,0 +1,60 @@
+"""
+autogenerate some tables for pylab namespace
+"""
+from pylab import *
+d = locals()
+keys = d.keys()
+keys.sort()
+
+modd = dict()
+for k in keys:
+    o = d[k]
+    if not callable(o):
+        continue
+    doc = getattr(o, '__doc__', None)
+    if doc is not None:
+        doc = ' - '.join([line for line in doc.split('\n') if line.strip()][:2])
+        
+    mod = getattr(o, '__module__', None)
+    if mod is None:
+        mod = 'unknown'
+
+    if mod is not None:
+        if mod.startswith('matplotlib'):
+            if k[0].isupper():
+                k = ':class:`~%s.%s`'%(mod, k)
+            else:
+                k = ':func:`~%s.%s`'%(mod, k)
+            mod = ':mod:`%s`'%mod            
+        elif mod.startswith('numpy'):
+            #k = '`%s <%s>`_'%(k, 'http://scipy.org/Numpy_Example_List_With_Doc#%s'%k)
+            k = '`%s <%s>`_'%(k, 'http://sd-2116.dedibox.fr/pydocweb/doc/%s.%s'%(mod, k))
+
+
+    if doc is None: doc = 'TODO'
+
+    mod, k, doc = mod.strip(), k.strip(), doc.strip()[:80]
+    modd.setdefault(mod, []).append((k, doc))
+
+mods = modd.keys()
+mods.sort()
+for mod in mods:
+    border = '*'*len(mod)
+    print mod
+    print border
+
+    print
+    funcs, docs = zip(*modd[mod])
+    maxfunc = max([len(f) for f in funcs])
+    maxdoc = max(40, max([len(d) for d in docs]) )
+    border = ' '.join(['='*maxfunc, '='*maxdoc])
+    print border
+    print ' '.join(['symbol'.ljust(maxfunc), 'description'.ljust(maxdoc)])
+    print border
+    for func, doc in modd[mod]:
+        row = ' '.join([func.ljust(maxfunc), doc.ljust(maxfunc)])
+        print row
+
+    print border
+    print
+    #break
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -1769,9 +1769,10 @@ def set_xbound(self, lower=None, upper=None):
 
     def get_xlim(self):
         """
-        Get the x-axis range [*xmin*, *xmax*]
+        Get the x-axis range as a length 2 attay [*xmin*, *xmax*]
         """
-        return tuple(self.viewLim.intervalx)
+        #         # copy of the viewlim array to avoid modify inplace surprises
+        return self.viewLim.intervalx.copy()
 
     def set_xlim(self, xmin=None, xmax=None, emit=True, **kwargs):
         """
@@ -1781,7 +1782,7 @@ def set_xlim(self, xmin=None, xmax=None, emit=True, **kwargs):
 
         Set the limits for the xaxis
 
-        Returns the current xlimits as a length 2 tuple: [*xmin*, *xmax*]
+        Returns the current xlimits as a length 2 tuple: (*xmin*, *xmax*)
 
         Examples::
 
@@ -1942,9 +1943,10 @@ def set_ybound(self, lower=None, upper=None):
 
     def get_ylim(self):
         """
-        Get the y-axis range [*ymin*, *ymax*]
+        Get the y-axis range as a length two array [*ymin*, *ymax*]
         """
-        return tuple(self.viewLim.intervaly)
+        # copy of the viewlim array to avoid modify inplace surprises
+        return self.viewLim.intervaly.copy()
 
     def set_ylim(self, ymin=None, ymax=None, emit=True, **kwargs):
         """
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
