fix(attributes-to-props): improve jsdoc documentation

adammockor · adammockor · commit 7f75bd8c3971 · 2023-01-05T19:53:38.000+01:00
diff --git a/lib/attributes-to-props.js b/lib/attributes-to-props.js
@@ -5,7 +5,7 @@ var utilities = require('./utilities');
  * Converts HTML/SVG DOM attributes to React props.
  *
  * @param {object} [attributes={}] - HTML/SVG DOM attributes.
- * @param {string} [nodeName] - DOM node.
+ * @param {string} [nodeName] - DOM node name. Help's to have smarter behavior while converting DOM attributes to props.
  * @returns - React props.
  */
 module.exports = function attributesToProps(attributes, nodeName) {

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ var utilities = require('./utilities');`
`5`	`5`	`* Converts HTML/SVG DOM attributes to React props.`
`6`	`6`	`*`
`7`	`7`	`* @param {object} [attributes={}] - HTML/SVG DOM attributes.`
`8`		`- * @param {string} [nodeName] - DOM node.`
	`8`	`+ * @param {string} [nodeName] - DOM node name. Help's to have smarter behavior while converting DOM attributes to props.`
`9`	`9`	`* @returns - React props.`
`10`	`10`	`*/`
`11`	`11`	`module.exports = function attributesToProps(attributes, nodeName) {`