changeset 8795:bb38a86efa1b

improve documentation for edit.m
author Ivan Sutoris <ivan.sutoris@gmail.com>
date Wed, 18 Feb 2009 01:31:14 -0500
parents f16aafdd99ca
children 9662dfb26652
files scripts/ChangeLog scripts/miscellaneous/edit.m
diffstat 2 files changed, 9 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,7 @@
+2009-02-18  Ivan Sutoris  <ivan.sutoris@gmail.com>
+
+	* miscellaneous/edit.m: Expand documentation about editor mode.
+
 2009-02-18  John W. Eaton  <jwe@octave.org>
 
 	* plot/__gnuplot_version__.m: Don't use regexp to extract version
--- 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