From c08459d99ad5e23d09c1e54764342422e07895cd Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Tue, 12 Jun 2018 13:17:01 +0100 Subject: [PATCH] Explain use of saver='string' in iris.save --- lib/iris/io/__init__.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/iris/io/__init__.py b/lib/iris/io/__init__.py index 202aba6e4b..6c739ffbc1 100644 --- 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