[Bug 20005] New: suppress default method return value

https://www.w3.org/Bugs/Public/show_bug.cgi?id=20005

          Priority: P2
            Bug ID: 20005
                CC: team-webplatform-admin@w3.org
          Assignee: schepers@w3.org
           Summary: suppress default method return value
        QA Contact: public-webplatform-bugs@w3.org
          Severity: normal
    Classification: Unclassified
                OS: All
          Reporter: letmespellitoutforyou@gmail.com
          Hardware: PC
            Status: NEW
           Version: unspecified
         Component: infrastructure
           Product: webplatform.org

See:
http://docs.webplatform.org/wiki/apis/css-regions/Region/getRegionFlowRanges

...which displays this text under "Return Value":

 Returns an object of type function.

 Returns a series of Range objects that represent the fragments of DOM content
that currently flow into the region.

The first "Returns" is auto-generated based on the interface member's identity
as a method, and the second is content I wrote.  I'd think the reader only
wants the return value of obj.method(). The fact that obj.method returns a
reference to the function seems pointlessly obvious.  You shouldn't have to
write the content pedantically as "When called as a method, returns..."

-- 
You are receiving this mail because:
You are the QA Contact for the bug.

Received on Monday, 19 November 2012 15:41:31 UTC