SF.net SVN: matplotlib:[6375] trunk/toolkits/basemap/lib/mpl_toolkits/ basemap/__init__.py

[<js...@us...>]

Revision: 6375
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6375&view=rev
Author:   jswhit
Date:     2008-11-08 17:08:25 +0000 (Sat, 08 Nov 2008)

Log Message:
-----------
add docstring for mmap NetCDFFile keyword.

Modified Paths:
--------------
    trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py

Modified: trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py
===================================================================
--- trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py	2008-11-08 17:02:38 UTC (rev 6374)
+++ trunk/toolkits/basemap/lib/mpl_toolkits/basemap/__init__.py	2008-11-08 17:08:25 UTC (rev 6375)
@@ -3763,6 +3763,9 @@
     ``cache`` is a location (a directory) for caching data, so that repeated
     accesses to the same URL avoid the network. 
 
+    The keyword ``mmap`` is only valid for local netCDF files.  When 
+    ``mmap=True`` (default), the mmap module is used to access the data.
+    This may be slow for very large netCDF variables.
     """
     import netcdf
     if file.startswith('http'):


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.