W3C home > Mailing lists > Public > public-webplatform@w3.org > February 2013

Complex Return Type Information

From: PhistucK <phistuck@gmail.com>
Date: Sat, 23 Feb 2013 21:18:56 +0200
Message-ID: <CABc02_+o8hmzzqDuNF3gPePrURZxe+bY7H+kfz0UmZrJ=XpP1Q@mail.gmail.com>
To: public-webplatform@w3.org
>From IRC (typos and redundancies were fixed) -
[21:09] <PhistucK> There is a general problem - some properties return
complex types, like HTMLCollection (document.anchors, element.children,
more). We should show the members of these returned objects within the
property. Right?
[21:11] <PhistucK> Like dom/properties/anchors should include all of the
methods that HTMLCollection has, like "namedItem".
[21:11] <PhistucK> getElement(s)ByX should include all of the members that
NodeList has and so on.
[21:11] <fr0zenice> mhm dunno, if it's a complex type, maybe with it's own
methods and stuff, could be worth a separate article/subarticles
[21:12] <PhistucK> Of course, but we should draw the members from it in
every property that returns it
[21:14] <PhistucK> Just writing, "returns an HTMLCollection" is not very
informative. We do it for objects. Everything should be as self contained
as possible. We want to avoid unnecessary navigations, I guess.
Extraneous navigations are not helpful.

Any thoughts? other solutions?

☆*PhistucK*
Received on Saturday, 23 February 2013 19:20:08 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 8 May 2013 19:57:39 UTC