diff libinterp/corefcn/defaults.cc @ 17991:22187db555cf

Remove editor option from edit() and use only EDITOR() (bug #40600) * edit.m: remove the option to specify a text editor for this function only to remove confusion about the 3 default text editors in Octave. Instead, check the value of EDITOR() everytime. * defaults.cc (FEDITOR): correct documentation since it is no longer only used by edit_history().
author Carnë Draug <carandraug@octave.org>
date Sat, 23 Nov 2013 23:01:13 +0000
parents 175b392e91fe
children d902542221c8
line wrap: on
line diff
--- a/libinterp/corefcn/defaults.cc
+++ b/libinterp/corefcn/defaults.cc
@@ -471,9 +471,10 @@
 @deftypefn  {Built-in Function} {@var{val} =} EDITOR ()\n\
 @deftypefnx {Built-in Function} {@var{old_val} =} EDITOR (@var{new_val})\n\
 @deftypefnx {Built-in Function} {} EDITOR (@var{new_val}, \"local\")\n\
-Query or set the internal variable that specifies the editor to\n\
-use with the @code{edit_history} command.  The default value is taken from\n\
-the environment variable @w{@env{EDITOR}} when Octave starts.  If the\n\
+Query or set the internal variable that specifies the default text editor.\n\
+\n\
+The default value is taken from the environment variable @w{@env{EDITOR}}\n\
+when Octave starts.  If the\n\
 environment variable is not initialized, @w{@env{EDITOR}} will be set to\n\
 @qcode{\"emacs\"}.\n\
 \n\
@@ -481,7 +482,7 @@
 variable is changed locally for the function and any subroutines it calls.  \n\
 The original variable value is restored when exiting the function.\n\
 \n\
-@seealso{edit_history}\n\
+@seealso{edit, edit_history}\n\
 @end deftypefn")
 {
   return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (EDITOR);