[Pkg-javascript-commits] [dojo] 28/149: Fix example for text() to be consistent w/actual behavior and function description. Fixes #18433.

[David Prévot]

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository dojo.

commit 6762d5baaa8b85d239d45eeda82e73689bb678d4
Author: Bill Keese <bill at dojotoolkit.org>
Date:   Mon Jan 5 02:34:42 2015 +0900

    Fix example for text() to be consistent w/actual behavior and function description.
    Fixes #18433.
---
 NodeList-manipulate.js | 24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)

diff --git a/NodeList-manipulate.js b/NodeList-manipulate.js
index 91d3b38..0be730b 100644
--- a/NodeList-manipulate.js
+++ b/NodeList-manipulate.js
@@ -149,30 +149,28 @@ define(["./query", "./_base/lang", "./_base/array", "./dom-construct", "./dom-at
 
 		text: function(/*String*/value){
 			// summary:
-			//		allows setting the text value of each node in the NodeList,
-			//		if there is a value passed in, otherwise, returns the text value for all the
+			//		Allows setting the text value of each node in the NodeList,
+			//		if there is a value passed in.  Otherwise, returns the text value for all the
 			//		nodes in the NodeList in one string.
 			// example:
-			//		assume a DOM created by this markup:
+			//		Assume a DOM created by this markup:
 			//	|	<div id="foo"></div>
 			//	|	<div id="bar"></div>
 			//		This code inserts "Hello World" into both divs:
-			//	|	require(["dojo/query", "dojo/NodeList-manipulate"
-			//	|	], function(query){
+			//	|	require(["dojo/query", "dojo/NodeList-manipulate"], function(query){
 			//	|		query("div").text("Hello World");
 			//	| 	});
 			// example:
-			//		assume a DOM created by this markup:
+			//		Assume a DOM created by this markup:
 			//	|	<div id="foo"><p>Hello Mars <span>today</span></p></div>
 			//	|	<div id="bar"><p>Hello World</p></div>
-			//		This code returns "Hello Mars today":
-			//	|	require(["dojo/query", "dojo/NodeList-manipulate"
-			//	|	], function(query){
-			//	|		var message = query("div").text();
+			//		This code writes "Hello Mars todayHello World" to the console:
+			//	|	require(["dojo/query", "dojo/NodeList-manipulate"], function(query){
+			//	|		console.log(query("div").text());
 			//	| 	});
 			// returns:
-			//		if no value is passed, the result is String, the text value of the first node.
-			//		If a value is passed, the return is this dojo/NodeList
+			//		If no value is passed, the result is String: the text value of the nodes.
+			//		If a value is passed, the return is this dojo/NodeList.
 			if(arguments.length){
 				for(var i = 0, node; node = this[i]; i++){
 					if(node.nodeType == 1){
@@ -191,7 +189,7 @@ define(["./query", "./_base/lang", "./_base/array", "./dom-construct", "./dom-at
 
 		val: function(/*String||Array*/value){
 			// summary:
-			//		If a value is passed, allows seting the value property of form elements in this
+			//		If a value is passed, allows setting the value property of form elements in this
 			//		NodeList, or properly selecting/checking the right value for radio/checkbox/select
 			//		elements. If no value is passed, the value of the first node in this NodeList
 			//		is returned.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/dojo.git