[m-rev.] trivial diff: document failure condition for pqueue.remove/4

[Julien Fischer]

Estimated hours taken: 0
Branches: main

library/pqueue.m:
 	Document the condition under which pqueue.remove/4 can fail.

Julien.

Index: pqueue.m
===================================================================
RCS file: /home/mercury/mercury1/repository/mercury/library/pqueue.m,v
retrieving revision 1.25
diff -u -r1.25 pqueue.m
--- pqueue.m	23 May 2007 10:09:24 -0000	1.25
+++ pqueue.m	4 Sep 2007 07:37:41 -0000
@@ -46,6 +46,7 @@
      is det.

      % Remove the smallest item from the priority queue.
+    % Fails if the priority queue is empty.
      %
  :- pred pqueue.remove(pqueue(K, V)::in, K::out, V::out, pqueue(K, V)::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
--------------------------------------------------------------------------