[m-rev.] for review: fix up comments for io.call_system_return_signal

[Ian MacLarty]

For review by anyone.

Estimated hours taken: 0.2
Branches: main and 0.12

Fix up comments for io.call_system_return_signal.

library/io.m
	Fix up comments for io.call_system_return_signal.

Index: library/io.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/io.m,v
retrieving revision 1.327
diff -u -r1.327 io.m
--- library/io.m	24 Jan 2005 23:16:37 -0000	1.327
+++ library/io.m	17 Feb 2005 10:17:35 -0000
@@ -1311,13 +1311,16 @@
 	--->	exited(int)
 	;	signalled(int).
 
+	% call_system_return_signal(Command, Result, !IO).
 	% Invokes the operating system shell with the specified
 	% Command.  Result is either `ok(ExitStatus)' if it was
-	% possible to invoke the command and the it ran to completion,
-	% `signal(SignalNum)' if the command was killed by a signal, or
-	% `error(ErrorCode)' if the command could not be executed.
-	% The `ExitStatus' will be 0 if the command completed
-	% successfully or the return value of the command otherwise.
+	% possible to invoke the command or `error(Error)' if the command
+	% could not be executed.  If the command could be executed then
+	% ExitStatus is either `exited(ExitCode)' if the command ran to 
+	% completion or `signalled(SignalNum)' if the command was killed by
+	% a signal.  If the command ran to completion then ExitCode will be 0 
+	% if the command ran successfully and the return value of the command
+	% otherwise.
 	%
 :- pred io__call_system_return_signal(string::in,
 	io__res(io__system_result)::out, io::di, io::uo) is det.
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------