[m-rev.] for review: extra comments in mdbcomp/program_representation.m

[Paul Bone]

For review by anyone.

I've posted this for review even though it's a trivial change because
I'm not the author of the module.

Estimated hours taken: 0.1 

Provided clearer comments on the behaviour of goal path functions and
predicates with respect to reversing the order of the goal path steps.

mdbcomp/program_representation.m:
    Added comments to the following predicates
        path_from_string_det
        path_from_string
    Modified comments on the following function
        goal_path_to_string

Index: mdbcomp/program_representation.m
===================================================================
RCS file: /home/mercury/mercury1/repository/mercury/mdbcomp/program_representation.m,v
retrieving revision 1.25
diff -u -u -r1.25 program_representation.m
--- mdbcomp/program_representation.m	23 Sep 2007 03:53:12 -0000	1.25
+++ mdbcomp/program_representation.m	27 Oct 2007 07:51:58 -0000
@@ -310,9 +310,11 @@
     --->    scope_is_cut
     ;       scope_is_no_cut.
 
+    % No reversing of the list is done by this predicate.
+    %
 :- pred path_from_string_det(string::in, goal_path::out) is det.
 
-    % This leaves the reverses the steps before converting them to a string.
+    % This reverses the steps before converting them to a string.
     %
 :- func goal_path_to_string(goal_path) = string.
 
@@ -322,6 +324,8 @@
     %
 :- func string_from_path(goal_path) = string.
 
+    % No reversing of the list is done by this predicate.
+    %
 :- pred path_from_string(string::in, goal_path::out) is semidet.
 
 :- pred path_step_from_string(string::in, goal_path_step::out) is semidet.

--------------------------------------------------------------------------
mercury-reviews mailing list
Post messages to:       mercury-reviews at csse.unimelb.edu.au
Administrative Queries: owner-mercury-reviews at csse.unimelb.edu.au
Subscriptions:          mercury-reviews-request at csse.unimelb.edu.au
--------------------------------------------------------------------------