Updated docs of simplify, extended algebra examples

josdejong · Aug 6, 2017 · 4fc0c4b · 4fc0c4b
1 parent fd87f83
commit 4fc0c4b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/examples/algebra.js b/examples/algebra.js
@@ -11,6 +11,7 @@ var math = require('../index');
 console.log('simplify expressions');
 console.log(math.simplify('3 + 2 / 4').toString());             // '7 / 2'
 console.log(math.simplify('2x + 3x').toString());               // '5 * x'
+console.log(math.simplify('2 * 3 * x', {x: 4}).toString());     // '24'
 console.log(math.simplify('x^2 + x + 3 + x^2').toString());     // '2 * x ^ 2 + x + 3'
 console.log(math.simplify('x * y * -x / (x ^ 2)').toString());  // '-y'
 

diff --git a/lib/function/algebra/simplify.js b/lib/function/algebra/simplify.js
@@ -60,10 +60,13 @@ function factory (type, config, load, typed, math) {
    *
    *     simplify(expr)
    *     simplify(expr, rules)
+   *     simplify(expr, rules, scope)
+   *     simplify(expr, scope)
    *
    * Examples:
    *
    *     math.simplify('2 * 1 * x ^ (2 - 1)');      // Node {2 * x}
+   *     math.simplify('2 * 3 * x', {x: 4});        // Node {24}
    *     var f = math.parse('2 * 1 * x ^ (2 - 1)');
    *     math.simplify(f);                          // Node {2 * x}
    *