Merge pull request #278 from e2tha-e/pattern-engines-docblock-update

a more accurate docblock

Author: geoffp

core/lib/pattern_engines/engine_mustache.js

@@ -46,12 +46,15 @@ var engine_mustache = {
     return Mustache.render(template, data);
   },
 
-  // find partials based on regex.
-  // @param {string|object} pattern - either a string or a pattern object.
-  // @param {object} regex - a JavaScript RegExp object.
-  // @returns {array}
-  partialsFinder: function partialsFinder(pattern, regex) {
-    var matches = [];
+  /**
+   * Find regex matches within both pattern strings and pattern objects.
+   *
+   * @param {string|object} pattern Either a string or a pattern object.
+   * @param {object} regex A JavaScript RegExp object.
+   * @returns {array|null} An array if a match is found, null if not.
+   */
+  patternMatcher: function patternMatcher(pattern, regex) {
+    var matches;
 
     if (typeof pattern === 'string') {
       matches = pattern.match(regex);
@@ -64,22 +67,22 @@ var engine_mustache = {
 
   // find and return any {{> template-name }} within pattern
   findPartials: function findPartials(pattern) {
-    var matches = this.partialsFinder(pattern, this.findPartialsRE);
+    var matches = this.patternMatcher(pattern, this.findPartialsRE);
     return matches;
   },
   findPartialsWithStyleModifiers: function (pattern) {
-    var matches = this.partialsFinder(pattern, this.findPartialsWithStyleModifiersRE);
+    var matches = this.patternMatcher(pattern, this.findPartialsWithStyleModifiersRE);
     return matches;
   },
 
   // returns any patterns that match {{> value(foo:"bar") }} or {{>
   // value:mod(foo:"bar") }} within the pattern
   findPartialsWithPatternParameters: function (pattern) {
-    var matches = this.partialsFinder(pattern, this.findPartialsWithPatternParametersRE);
+    var matches = this.patternMatcher(pattern, this.findPartialsWithPatternParametersRE);
     return matches;
   },
   findListItems: function (pattern) {
-    var matches = this.partialsFinder(pattern, this.findListItemsRE);
+    var matches = this.patternMatcher(pattern, this.findListItemsRE);
     return matches;
   },