Permalink
Browse files

Fix docs for String#replace parameters.

Original MDC docs listed 4 parameters - it's more accurate to list two,
both of which can be of two types.
  • Loading branch information...
1 parent 3536e7f commit c6f00bff82f9ab71a15d636e997a764f592f8fcd @nene nene committed Nov 9, 2011
Showing with 10 additions and 8 deletions.
  1. +10 −8 js-classes/String.js
View
@@ -666,14 +666,16 @@
* return s.replace(test, convert);
* }
*
- * @param {RegExp} regexp A RegExp object. The match is replaced by the return value of parameter #2.
- * @param {String} substr A String that is to be replaced by `newSubStr`.
- * @param {String} newSubStr The String that replaces the substring received from parameter #1. A
- * number of special replacement patterns are supported; see the "Specifying a string as a parameter"
- * section below.
- * @param {Function} function A function to be invoked to create the new substring (to put in place
- * of the substring received from parameter #1). The arguments supplied to this function are described
- * in the "Specifying a function as a parameter" section below.
+ * @param {String/RegExp} pattern Either a string or regular expression pattern to search for.
+ *
+ * @param {String/Function} replacement Either string or function:
+ *
+ * - The String to replace the `pattern` with. Number of special replacement patterns are supported;
+ * see the "Specifying a string as a parameter" section above.
+ * - A function to be invoked to create the replacement.
+ * The arguments supplied to this function are described in the "Specifying a function as a parameter"
+ * section above.
+ *
* @return {String} String of matched replaced items.
*/

0 comments on commit c6f00bf

Please sign in to comment.