# HG changeset patch # User Ivan Sutoris # Date 1234938674 18000 # Node ID bb38a86efa1bc30ce84950345dfd2de11d639a61 # Parent f16aafdd99ca4d75146b9b7f175ae27bc95bec90 improve documentation for edit.m diff --git a/scripts/ChangeLog b/scripts/ChangeLog --- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2009-02-18 Ivan Sutoris + + * miscellaneous/edit.m: Expand documentation about editor mode. + 2009-02-18 John W. Eaton * plot/__gnuplot_version__.m: Don't use regexp to extract version diff --git a/scripts/miscellaneous/edit.m b/scripts/miscellaneous/edit.m --- a/scripts/miscellaneous/edit.m +++ b/scripts/miscellaneous/edit.m @@ -83,6 +83,8 @@ ## Send it to current Emacs; must have @code{(gnuserv-start)} in @file{.emacs}. ## @end table ## +## See also field 'mode', which controls how the editor is run by Octave. +## ## On cygwin, you will need to convert the cygwin path to a windows ## path if you are using a native Windows editor. For example ## @example @@ -120,8 +122,9 @@ ## ## @item mode ## This value determines whether the editor should be started in async mode -## or sync mode. Set it to "async" to start the editor in async mode. The -## default is "sync" (see also "system"). +## (editor is started in the background and Octave continues) or sync mode +## (Octave waits until the editor exits). Set it to "async" to start the editor +## in async mode. The default is "sync" (see also "system"). ## ## @item editinplace ## Determines whether files should be edited in place, without regard to