Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#119 Docs: queue peek/pull should state return value on empty q

v3.0
closed
David Ashley
5
2012-08-14
2006-01-08
Mark Miesfeld
No

Not so much a bug as an omission, and I admint a
little nitpicky.

In the docs for the .queue methods pull and peek, I
believe they would be improved by stating explictly
that .nil is returned when the queue is empty. I
think they should be documented in a similar manner
to the remove method:

Open Object Rexx
Reference
Version 3.0.0 Revision 3 Edition
November 11, 2005

5.5.7. PEEK

-PEEK-----------------------------------------------
---------><
Returns the item at the head of the queue. The
collection remains unchanged.

5.5.8. PULL

-PULL-----------------------------------------------
---------><
Returns and removes the item at the head of the queue.

5.5.12. REMOVE

-REMOVE(index)--------------------------------------
---------><
Returns and removes from a collection the member item
with index index. If no item has index index,
this method returns the NIL object and removes no
item.

Discussion

  • David Ashley
    David Ashley
    2006-01-09

    Logged In: YES
    user_id=931756

    Additional information has been added per the original request.

     


Anonymous


Cancel   Add attachments