[Bug 15252] New: Documentation error - TreeWalker.nextNode()

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

           Summary: Documentation error - TreeWalker.nextNode()
           Product: WebAppsWG
           Version: unspecified
          Platform: PC
        OS/Version: Windows NT
            Status: NEW
          Severity: minor
          Priority: P2
         Component: DOM Core
        AssignedTo: annevk@opera.com
        ReportedBy: brandonyoyoslade@gmail.com
         QAContact: member-webapi-cvs@w3.org
                CC: mike@w3.org, www-dom@w3.org


The current instructions for implementing this method can be found at
http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#dom-treewalker-nextnode.

Step 3.2 states that implementors should:

"If a node is following node and is not following root, set node to the first
such node. Otherwise, run these substeps again."

Earlier in the steps, you were instructed to set node to currentNode. Since
currentNode is always a descendant of root, this means that the first "if"
statement is never true - the "otherwise" or "else" clause is executed
immediately. After some thought, I believe that you meant the following
instead:

"If a node is following node and is A DESCENDANT OF root, set node to the first
such node. Otherwise, run these substeps again."

If this is what you meant, then please change it. If not, then please clear up
exactly what you meant.

Also, there is a step 3.3, so consider changing the second sentence of 3.2 to
"Otherwise, SKIP THE REMAINING SUBSTEPS AND THEN run them again." or
"Otherwise, SKIP STEP 3 AND THEN run these substeps again."

-- 
Configure bugmail: https://www.w3.org/Bugs/Public/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.

Received on Saturday, 17 December 2011 01:28:13 UTC