[Octave-bug-tracker] [bug #57670] document uigetdir/uigetfile return value when Cancel is hit

[A.R. Burgers]

URL:
  <https://savannah.gnu.org/bugs/?57670>

                 Summary: document uigetdir/uigetfile return value when Cancel
is hit
                 Project: GNU Octave
            Submitted by: arb
            Submitted on: Sun 26 Jan 2020 08:15:12 PM UTC
                Category: Octave Function
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: Any

    _______________________________________________________

Details:

the uigetdir/uigetfile documentation does not mention the return value in case
the user hits the cancel button in the dialog, I suggest to add a line like
this:


diff -r e6482c932d4b scripts/gui/uigetdir.m
--- a/scripts/gui/uigetdir.m    Sun Jan 26 17:00:05 2020 +0100
+++ b/scripts/gui/uigetdir.m    Sun Jan 26 21:08:25 2020 +0100
@@ -31,6 +31,8 @@
 ##
 ## If @var{init_path} is not given the current working directory is used.
 ##
+## If the user hits the Cancel button in the dialog, uigetdir returns a 0 of
class double.
+##
 ## @var{dialog_name} may be used to customize the dialog title.
 ## @seealso{uigetfile, uiputfile}
 ## @end deftypefn
diff -r e6482c932d4b scripts/gui/uigetfile.m
--- a/scripts/gui/uigetfile.m   Sun Jan 26 17:00:05 2020 +0100
+++ b/scripts/gui/uigetfile.m   Sun Jan 26 21:08:25 2020 +0100
@@ -34,6 +34,8 @@
 ## Open a GUI dialog for selecting a file and return the filename
@var{fname},
 ## the path to this file @var{fpath}, and the filter index @var{fltidx}.
 ##
+## If the user hits the Cancel button in the dialog, uigetdir returns a 0 of
class double.
+##
 ## @var{flt} contains a (list of) file filter string(s) in one of the
following
 ## formats:
 ##





    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?57670>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/