[Oorexx-devel] ooRexx Docs and Consistency

[David A. <da...@us...>]

All -

In updating the reference doc with the new classes and methods it has
become obvious that the docs are not consistent when identifying
instance/class methods and the class they actually belong to. For insta=
nce,
the Bag Class is a good example. The docs identify the [] (square brack=
ets)
method as belonging to the Bag class when in reality it really belongs =
to
the superclass Relation (Bag is a subclass of Relation). There are plen=
ty
of other examples of this kind of thing in the docs.

Now for the question. Do we want to continue this concept? I have mixed=

emotions about it. On the one hand it really makes the documentation
inconsistent with reality. On the other hand I like the idea that impor=
tant
methods are identified and documented within a class definition in the =
docs
as it keeps the number of lookups the user has to perform to a minimum.=
 But
what does everyone else think?

My personal preference is to continue this practice but identify a meth=
od
as belonging to the superclass when that is the case. Or at least suppl=
ying
a linkable cross reference to the superclass method. But I am open to a=
ll
ideas.

Thanks,
W. David Ashley
IBM Systems and Technology Group Lab Services
Open Object Rexx Team
Office Phone: 512-838-0609 T/L 678-0609
Mobile Phone: 512-289-7506=