From 5a63be98ae693437705cf899e9b60d95e021c355 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 14 Jul 2023 16:25:41 -0400 Subject: [PATCH] docs: update namespace table of contents PR-URL: https://github.com/stdlib-js/stdlib/pull/1050 Co-authored-by: Athan Reines Reviewed-by: Athan Reines --- lib/node_modules/@stdlib/math/base/special/README.md | 6 +++--- lib/node_modules/@stdlib/string/README.md | 3 +++ lib/node_modules/@stdlib/string/base/distances/README.md | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/README.md b/lib/node_modules/@stdlib/math/base/special/README.md index 55f86f5077d..2e722d8c435 100644 --- a/lib/node_modules/@stdlib/math/base/special/README.md +++ b/lib/node_modules/@stdlib/math/base/special/README.md @@ -156,9 +156,9 @@ var fcns = special; - [`cfloorn( [out,] re, im, n )`][@stdlib/math/base/special/cfloorn]: round a complex number to the nearest multiple of `10^n` toward negative infinity. - [`clamp( v, min, max )`][@stdlib/math/base/special/clamp]: restrict a double-precision floating-point number to a specified range. - [`clampf( v, min, max )`][@stdlib/math/base/special/clampf]: restrict a single-precision floating-point number to a specified range. -- [`cround( [out,] re, im )`][@stdlib/math/base/special/cround]: round a complex number to the nearest integer. +- [`cround( z )`][@stdlib/math/base/special/cround]: round each component of a double-precision complex floating-point number to the nearest integer. - [`croundn( [out,] re, im, n )`][@stdlib/math/base/special/croundn]: round a complex number to the nearest multiple of `10^n`. -- [`csignum( [out,] re, im )`][@stdlib/math/base/special/csignum]: evaluate the signum function of a complex number. +- [`csignum( z )`][@stdlib/math/base/special/csignum]: evaluate the signum function of a double-precision complex floating-point number. - [`floor( x )`][@stdlib/math/base/special/floor]: round a double-precision floating-point number toward negative infinity. - [`floor10( x )`][@stdlib/math/base/special/floor10]: round a numeric value to the nearest power of 10 toward negative infinity. - [`floor2( x )`][@stdlib/math/base/special/floor2]: round a numeric value to the nearest power of two toward negative infinity. @@ -230,7 +230,7 @@ var fcns = special; - [`copysignf( x, y )`][@stdlib/math/base/special/copysignf]: return a single-precision floating-point number with the magnitude of `x` and the sign of `y`. - [`cot( x )`][@stdlib/math/base/special/cot]: evaluate the cotangent of a number. - [`coth( x )`][@stdlib/math/base/special/coth]: compute the hyperbolic cotangent of a number. -- [`cphase( re, im )`][@stdlib/math/base/special/cphase]: compute the argument of a complex number in radians. +- [`cphase( z )`][@stdlib/math/base/special/cphase]: compute the argument of a double-precision complex floating-point number in radians. - [`cpolar( [out,] re, im )`][@stdlib/math/base/special/cpolar]: compute the absolute value and phase of a complex number. - [`csch( x )`][@stdlib/math/base/special/csch]: compute the hyperbolic cosecant of a number. - [`deg2rad( x )`][@stdlib/math/base/special/deg2rad]: convert an angle from degrees to radians. diff --git a/lib/node_modules/@stdlib/string/README.md b/lib/node_modules/@stdlib/string/README.md index b4da2b4386e..1738d48fd4e 100644 --- a/lib/node_modules/@stdlib/string/README.md +++ b/lib/node_modules/@stdlib/string/README.md @@ -51,6 +51,7 @@ The namespace exposes the following string manipulation functions: - [`capitalize( str )`][@stdlib/string/capitalize]: capitalize the first character in a string. - [`codePointAt( string, position[, backward] )`][@stdlib/string/code-point-at]: return a Unicode code point from a string at a specified position. - [`constantcase( str )`][@stdlib/string/constantcase]: convert a string to constant case. +- [`dotcase( str )`][@stdlib/string/dotcase]: convert a string to dot case. - [`endsWith( str, search[, len] )`][@stdlib/string/ends-with]: test if a string ends with the characters of another string. - [`first( str[, n] )`][@stdlib/string/first]: return the first visual character(s) of a string. - [`forEach( str, clbk[, thisArg ] )`][@stdlib/string/for-each]: invokes a callback once for each (visual) character of a string. @@ -150,6 +151,8 @@ console.log( getKeys( string ) ); [@stdlib/string/constantcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/constantcase +[@stdlib/string/dotcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/dotcase + [@stdlib/string/ends-with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/ends-with [@stdlib/string/first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/first diff --git a/lib/node_modules/@stdlib/string/base/distances/README.md b/lib/node_modules/@stdlib/string/base/distances/README.md index 6c9cff112a7..a160ee4276a 100644 --- a/lib/node_modules/@stdlib/string/base/distances/README.md +++ b/lib/node_modules/@stdlib/string/base/distances/README.md @@ -45,7 +45,7 @@ The namespace contains the following functions:
-- [`levenshteinDistance( s1, s2 )`][@stdlib/string/base/distances/levenshtein]: calculates the Levenshtein (edit) distance between two strings. +- [`levenshteinDistance( s1, s2 )`][@stdlib/string/base/distances/levenshtein]: calculate the Levenshtein (edit) distance between two strings.