Explain use of saver='string' in iris.save (#3062)

SciTools · Jun 18, 2018 · 220c272 · 220c272
1 parent dbe1bc3
commit 220c272
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/lib/iris/io/__init__.py b/lib/iris/io/__init__.py
@@ -346,11 +346,12 @@ def save(source, target, saver=None, **kwargs):
 
     Kwargs:
 
-        * saver     - Optional. Specifies the save function to use.
+        * saver     - Optional. Specifies the file format to save.
                       If omitted, Iris will attempt to determine the format.
 
-                      This keyword can be used to implement a custom save
-                      format. Function form must be:
+                      If a string, this is the recognised filename extension
+                      (where the actual filename may not have it).
+                      Otherwise the value is a saver function, of the form:
                       ``my_saver(cube, target)`` plus any custom keywords. It
                       is assumed that a saver will accept an ``append`` keyword
                       if it's file format can handle multiple cubes. See also