From b2f23c853e545c37b2b1680a8789ae9e3bc1cbf3 Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Wed, 28 Jan 2015 21:32:32 +0000 Subject: [PATCH] fix pydocs snafu --- doc/reference/using-python.xml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/reference/using-python.xml b/doc/reference/using-python.xml index 7f63df77..123ea99f 100644 --- a/doc/reference/using-python.xml +++ b/doc/reference/using-python.xml @@ -161,11 +161,15 @@ min_value = im.min() optional output arguments. Call it like this: -min_value, x_pos, y_pos = im.min(x = True, y = True) +min_value, opts = im.min(x = True, y = True) +x = opts['x'] +y = opts['y'] - Although in this case, the .minpos() convenience - function would be simpler. + In other words, if optional output args are requested, an extra + dictionary is returned containing those objects. + Of course in this case, the .minpos() convenience + function would be simpler, see below.