some docstring cleanup on recs_join and align_iterators

jdh2358 · jdh2358 · commit e86e3255981f · 2009-09-11T21:02:27.000Z
svn path=/trunk/matplotlib/; revision=7747
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -390,7 +390,7 @@ def read_cache(self):
         for url, (fn, x, y) in cache.items():
             if not os.path.isabs(fn):
                 cache[url] = (self.in_cache_dir(fn), x, y)
-        
+
         # If any files are deleted, drop them from the cache
         for url, (fn, _, _) in cache.items():
             if not os.path.exists(fn):
@@ -525,7 +525,7 @@ def get_sample_data(self, fname, asfileobj=True):
             msg = 'file %s not in cache; received %s when trying to retrieve' \
                 % (fname, error)
             raise KeyError(msg)
-        
+
         fname = cached[0]
 
         if asfileobj:
@@ -1627,11 +1627,13 @@ def quad2cubic(q0x, q0y, q1x, q1y, q2x, q2y):
     return mlab.quad2cubic(q0x, q0y, q1x, q1y, q2x, q2y)
 
 def align_iterators(func, *iterables):
-    """ 
-        This generator takes a bunch of iterables that are ordered by func
-        It sends out ordered tuples (func(row), [rows from all iterators matching func(row)])
-        
-        It is used by mlab.recs_join to join record arrays
+    """
+    This generator takes a bunch of iterables that are ordered by func
+    It sends out ordered tuples:
+
+      (func(row), [rows from all iterators matching func(row)])
+
+    It is used by :func:`matplotlib.mlab.recs_join` to join record arrays
     """
     class myiter:
         def __init__(self, it):
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -1884,15 +1884,26 @@ def mapped_r2field(name):
     return newrec
 
 def recs_join(key, name, recs,missing=0.):
-    """ 
-    *key* is the column name that acts as a key
-    *name* is the name that we want to join
-    *missing" is what the missing fields are replaced by
-    *recarrays* is a list of record arrays to join
+    """
+    Join a sequence of record arrays on key
+
+    *key*
+      is the column name that acts as a key
+
+    *name*
+      is the name that we want to join
+
+    *missing"
+      is what the missing fields are replaced by
+
+    *recarrays*
+      is a list of record arrays to join
 
     returns a record array with columns [rowkey, name1, name2, ... namen]
 
-    >>> r = recs_join("date", "close", recs=[r0, r1], missing=0.)
+    Example::
+
+      r = recs_join("date", "close", recs=[r0, r1], missing=0.)
 
     """
     results = []
diff --git a/make.osx b/make.osx
@@ -61,7 +61,7 @@ freetype: zlib
 	cd freetype-${FREETYPEVERSION} &&\
 	export MACOSX_DEPLOYMENT_TARGET=${MACOSX_DEPLOYMENT_TARGET} &&\
 	export CFLAGS=${CFLAGS_DEPS} &&\
-	export LDFLAGS=${LDFLAGS_DEPS} &&\
+	export LDFLAGS=${LDFLAGS_DEPS} &&\python/svn/bison/scripts/
 	./configure  --prefix=${PREFIX} &&\
 	make -j3 install &&\
 	cp objs/.libs/libfreetype.a .  &&\
@@ -76,8 +76,6 @@ mpl_build:
 	export MACOSX_DEPLOYMENT_TARGET=${MACOSX_DEPLOYMENT_TARGET} &&\
 	export CFLAGS=${CFLAGS_DEPS} &&\
 	export LDFLAGS=${LDFLAGS_DEPS} &&\
-	export LD_LIBRARY_PATH=${PREFIX}/lib &&\
-	export DYLD_LIBRARY_PATH=${PREFIX}/lib &&\
 	python setup.py build
 
 mpl_install:
