Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jun 18, 2018
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions lib/iris/io/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down