Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#190 Suggest corrections to 5.3.8

v4.2.0
closed
Rick McGuire
None
3
2014-04-15
2012-09-27
Walter
No

5.3.8.3. init >>-init(--size--)><
should be new

5.3.8.5. push
If option is ’Unique’, any matching item already in the queue ...
should be items (plural)

5.3.8.6. queue
also plural

5.3.8.7. resize
If the previous size was larger than newSize, any extra items are removed in the specified order.
should be
If there are more than newSize items are in the queue...

First-in, first-out. This keeps the most recently added items.
The order of inserting is not relevant!!! The items on top are removed...

5.3.8.11. Example
u~resize(2, "LILO")
should be
u~resize(2, "LIFO") (although it's ireelevant)

Related

Documentation Bugs: #190

Discussion

1 2 > >> (Page 1 of 2)
  • Erich
    Erich
    2013-06-05

    To fix [documentation:#190] bug, this patch changes file collclasses.xml in docs/branches/4.1.3/trunk/rexxref
    It should also apply cleanly to docs/branches/4.1/trunk/rexxref

    (Please see follow-on post for an equivalent patch for /docs/trunk/rexxref)

    --- collclasses.xml (revision 9260)
    Complete replacement of method init() description with method new() description
    Standardized syntax diagram for method makeArray()
    Added "Items are returned beginning from the queue head." to "Fifo" description
    Added "Items are returned beginning from the queue tail." to "Lifo" description
    Standardized syntax diagram for method push()
    Added ", at the queue head." to push() description
    Changed "If the circular queue is full, then the last item stored in the circular queue" to ".. then the item at the queue tail"
    "item" -> "items" in "any matching item already in the queue will be removed"
    Standardized syntax diagram for method queue()
    Changed "at the end of the circular queue" to "at the tail .."
    Changed "first item" to "item at the queue head" in "If the circular queue is full, then the first item will be deleted"
    "item" -> "items" in "any matching item already in the queue will be removed"
    Standardized syntax diagram for method resize()
    Changed "If the previous size was larger than newSize" to "If there are currently more than newSize items in the queue"
    Changed "This keeps the most recently added items" to "This removes items at the queue head"
    Changed "This removes the most recently added items" to "This removes items at the queue tail"
    Standardized syntax diagram for method string()
    Added "Items are concatenated beginning from the queue head." to "Fifo" description
    Added "Items are concatenated beginning from the queue tail." to "Lifo" description
    Standardized syntax diagram for method supplier()
    Added "Iteration will begin from the queue head." to "Fifo" description
    Added "Iteration will begin from the queue tail." to "Lifo" description
    Changed "buffer" to "queue" in "create a circular buffer with five items"
    Changed example to use "items at tail" instead of "newest" and "items at head" instead of "oldest"

     

    Related

    Documentation Bugs: #190

    Attachments
  • Rick McGuire
    Rick McGuire
    2013-06-05

    Removing the append method description is not correct for the trunk. In
    the current trunk version, append has been overridden to correct the
    problem you already noted with append not respecting size.

    On Wed, Jun 5, 2013 at 8:54 AM, Erich erich_st@users.sf.net wrote:

    To fix [documentation:#190] bug, this patch changes file collclasses.xml
    /docs/trunk/rexxref)

    --- collclasses.xml (revision 9260)
    All changes as listed in previous post, plus:

    Removed description of inherited method append()
    Removed superfluous ":" in "Note:"

    Attachment: collclasses-cq-trunk.diff (11.0 kB; application/octet-stream)


    [documentation:#190] Suggest corrections to 5.3.8

    Status: open
    Created: Thu Sep 27, 2012 01:34 PM UTC by Walter
    Last Updated: Wed Jun 05, 2013 12:48 PM UTC
    Owner: nobody

    5.3.8.3. init >>-init(--size--)><
    should be new

    5.3.8.5. push
    If option is ’Unique’, any matching item already in the queue ...
    should be items (plural)

    5.3.8.6. queue
    also plural

    5.3.8.7. resize
    If the previous size was larger than newSize, any extra items are removed
    in the specified order.
    should be
    If there are more than newSize items are in the queue...

    First-in, first-out. This keeps the most recently added items.
    The order of inserting is not relevant!!! The items on top are removed...

    5.3.8.11. Example
    u~resize(2, "LILO")
    should be
    u~resize(2, "LIFO") (although it's ireelevant)


    Sent from sourceforge.net because you indicated interest in <
    https://sourceforge.net/p/oorexx/documentation/190/>

    To unsubscribe from further messages, please visit <
    https://sourceforge.net/auth/subscriptions/>

     

    Related

    Documentation Bugs: #190

  • Erich
    Erich
    2013-06-05

    Removing the append method description is not correct for the trunk. In
    the current trunk version, append has been overridden to correct the
    problem you already noted with append not respecting size.

    Didn't know that, thanks for checking, Rick!

    Please find attached a modified patch. It changes file collclasses.xml in /docs/trunk/rexxref

    --- collclasses.xml
    It should do all changes as listed in my previous post for 4.1.3/trunk and 4.1/trunk, plus:

    Removed superfluous ":" in "Note:"

     
  • Rick McGuire
    Rick McGuire
    2013-12-06

    The change to init method is not correct. init is the correct method here. Other changes have been implemented.

     
  • Walter Pachl
    Walter Pachl
    2013-12-08

    I tried this little program (unsuccessfully so):
    Parse Version v
    Say v
    u=.circularQueue~init(3)
    say "content: ["u"]," "content (LIFO): ["u~string("->","L")"]"
    say
    / gives this error:
    3
    - u=.circularQueue~init(3)
    Error 93 running D:\cq.rex line 3: Incorrect call to method
    Error 93.902: Too many arguments in invocation of method; 0 expected
    /

     
    • Rick McGuire
      Rick McGuire
      2013-12-08

      Because that is not the way INIT methods work. It is a method of a
      circularqueue instance, not the circularqueue class. For most classes, the
      new() is just inherited for class, and any arguments to new are just passed
      along to the init() method after the object has been allocated. The init
      method then completes the initialization. It is important to document the
      init methods because if you create your own subclass of that class, you'll
      need to ensure you pass along the right arguments if you override the init
      method. As I said earlier, changing that to NEW is an incorrect change.

      On Sun, Dec 8, 2013 at 1:17 PM, Walter Pachl walterpachl@users.sf.netwrote:

      I tried this little program (unsuccessfully so):
      Parse Version v
      Say v
      u=.circularQueue~init(3)
      say "content: ["u"]," "content (LIFO): ["u~string("->","L")"]"
      say
      / gives this error:
      3
      - u=.circularQueue~init(3)
      Error 93 running D:\cq.rex line 3: Incorrect call to method
      Error 93.902: Too many arguments in invocation of method; 0 expected
      /


      [documentation:#190] Suggest corrections to 5.3.8

      Status: pending
      Created: Thu Sep 27, 2012 01:34 PM UTC by Walter
      Last Updated: Fri Dec 06, 2013 07:42 PM UTC
      Owner: Rick McGuire

      5.3.8.3. init >>-init(--size--)><
      should be new

      5.3.8.5. push
      If option is ’Unique’, any matching item already in the queue ...
      should be items (plural)

      5.3.8.6. queue
      also plural

      5.3.8.7. resize
      If the previous size was larger than newSize, any extra items are removed
      in the specified order.
      should be
      If there are more than newSize items are in the queue...

      First-in, first-out. This keeps the most recently added items.
      The order of inserting is not relevant!!! The items on top are removed...

      5.3.8.11. Example
      u~resize(2, "LILO")
      should be
      u~resize(2, "LIFO") (although it's ireelevant)


      Sent from sourceforge.net because you indicated interest in <
      https://sourceforge.net/p/oorexx/documentation/190/>

      To unsubscribe from further messages, please visit <
      https://sourceforge.net/auth/subscriptions/>

       

      Related

      Documentation Bugs: #190

      • Walter Pachl
        Walter Pachl
        2013-12-08

        I could not create a working example
        Cam you pls send me one?
        --
        Walter Pachl

        ---- Rick McGuire bigrixx@users.sf.net schrieb:

        Because that is not the way INIT methods work. It is a method of a
        circularqueue instance, not the circularqueue class. For most classes, the
        new() is just inherited for class, and any arguments to new are just passed
        along to the init() method after the object has been allocated. The init
        method then completes the initialization. It is important to document the
        init methods because if you create your own subclass of that class, you'll
        need to ensure you pass along the right arguments if you override the init
        method. As I said earlier, changing that to NEW is an incorrect change.

        On Sun, Dec 8, 2013 at 1:17 PM, Walter Pachl walterpachl@users.sf.netwrote:

        I tried this little program (unsuccessfully so):
        Parse Version v
        Say v
        u=.circularQueue~init(3)
        say "content: ["u"]," "content (LIFO): ["u~string("->","L")"]"
        say
        / gives this error:
        3
        - u=.circularQueue~init(3)
        Error 93 running D:\cq.rex line 3: Incorrect call to method
        Error 93.902: Too many arguments in invocation of method; 0 expected
        /


        [documentation:#190] Suggest corrections to 5.3.8

        Status: pending
        Created: Thu Sep 27, 2012 01:34 PM UTC by Walter
        Last Updated: Fri Dec 06, 2013 07:42 PM UTC
        Owner: Rick McGuire

        5.3.8.3. init >>-init(--size--)><
        should be new

        5.3.8.5. push
        If option is ’Unique’, any matching item already in the queue ...
        should be items (plural)

        5.3.8.6. queue
        also plural

        5.3.8.7. resize
        If the previous size was larger than newSize, any extra items are removed
        in the specified order.
        should be
        If there are more than newSize items are in the queue...

        First-in, first-out. This keeps the most recently added items.
        The order of inserting is not relevant!!! The items on top are removed...

        5.3.8.11. Example
        u~resize(2, "LILO")
        should be
        u~resize(2, "LIFO") (although it's ireelevant)


        Sent from sourceforge.net because you indicated interest in <
        https://sourceforge.net/p/oorexx/documentation/190/>

        To unsubscribe from further messages, please visit <
        https://sourceforge.net/auth/subscriptions/>


        [documentation:#190] Suggest corrections to 5.3.8

        Status: pending
        Created: Thu Sep 27, 2012 01:34 PM UTC by Walter
        Last Updated: Sun Dec 08, 2013 06:21 PM UTC
        Owner: Rick McGuire

        5.3.8.3. init >>-init(--size--)><

        should be new

        5.3.8.5. push
        If option is ’Unique’, any matching item already in the queue ...
        should be items (plural)

        5.3.8.6. queue
        also plural

        5.3.8.7. resize
        If the previous size was larger than newSize, any extra items are removed in the specified order.
        should be
        If there are more than newSize items are in the queue...

        First-in, first-out. This keeps the most recently added items.
        The order of inserting is not relevant!!! The items on top are removed...

        5.3.8.11. Example
        u~resize(2, "LILO")
        should be
        u~resize(2, "LIFO") (although it's ireelevant)


        Sent from sourceforge.net because you indicated interest in https://sourceforge.net/p/oorexx/documentation/190/

        To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/

         

        Related

        Documentation Bugs: #190

1 2 > >> (Page 1 of 2)


Anonymous


Cancel   Add attachments