Mercurial > octave

diff scripts/gui/uigetdir.m @ 28022:306df6825dd9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Document return values for uigetdir/uigetfil when 'Cancel' button used (bug #57670). * uigetdir.m, uigetfile.m: Document return value of "double (0)" when 'Cancel' button used.
author Rik <rik@octave.org>
date Tue, 28 Jan 2020 07:59:52 -0800
parents a4268efb7334
children 28de41192f3c 0a5b15007766
line wrap: on
line diff
--- a/scripts/gui/uigetdir.m	Tue Jan 28 11:00:09 2020 +0900
+++ b/scripts/gui/uigetdir.m	Tue Jan 28 07:59:52 2020 -0800
@@ -32,6 +32,10 @@
 ## If @var{init_path} is not given the current working directory is used.
 ##
 ## @var{dialog_name} may be used to customize the dialog title.
+##
+## The output @var{dirname} is a character string with the name of the selected
+## directory.  However, if the @samp{Cancel} button is clicked the output is of
+## type double with the value @code{0}.
 ## @seealso{uigetfile, uiputfile}
 ## @end deftypefn