Add a minor jsDoc description

richrdkng · richrdkng · commit fe3569f2a96b · 2016-07-31T00:33:17.000+02:00
diff --git a/src/js-partial-foreach.js b/src/js-partial-foreach.js
@@ -65,7 +65,10 @@
     // Config options
 
         /**
-         * The config object of "foreach", which holds the global configuration.
+         * The config typedef of "foreach", which describes possible configurations.
+         *
+         * This typedef is used internally, but it can be used also as a **helper guide, when changing configurations**.
+         * Do not worry about incidentally changing the internal or global options of "foreach" by using this typedef.
          *
          * @typedef {Object} config
          *

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,10 @@`
`65`	`65`	`// Config options`
`66`	`66`
`67`	`67`	`/**`
`68`		`- * The config object of "foreach", which holds the global configuration.`
	`68`	`+ * The config typedef of "foreach", which describes possible configurations.`
	`69`	`+ *`
	`70`	`+ * This typedef is used internally, but it can be used also as a helper guide, when changing configurations.`
	`71`	`+ * Do not worry about incidentally changing the internal or global options of "foreach" by using this typedef.`
`69`	`72`	`*`
`70`	`73`	`* @typedef {Object} config`
`71`	`74`	`*`