docs: describe all signatures in the docs of function round

josdejong · Nov 15, 2023 · 71cadf1 · 71cadf1
1 parent 23fcb98
commit 71cadf1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/expression/embeddedDocs/function/arithmetic/round.js b/src/expression/embeddedDocs/function/arithmetic/round.js
@@ -3,7 +3,9 @@ export const roundDocs = {
   category: 'Arithmetic',
   syntax: [
     'round(x)',
-    'round(x, n)'
+    'round(x, n)',
+    'round(unit, valuelessUnit)',
+    'round(unit, n, valuelessUnit)',
   ],
   description:
       'round a value towards the nearest integer.If x is complex, both real and imaginary part are rounded towards the nearest integer. When n is specified, the value is rounded to n decimals.',

diff --git a/src/function/arithmetic/round.js b/src/function/arithmetic/round.js
@@ -30,6 +30,7 @@ export const createRound = /* #__PURE__ */ factory(name, dependencies, ({ typed,
    *
    *    math.round(x)
    *    math.round(x, n)
+   *    math.round(unit, valuelessUnit)
    *    math.round(unit, n, valuelessUnit)
    *
    * Examples: