Skip to content

Commit 2bcd3c8

Browse files
docs: update function description in math/base/special/log
PR-URL: stdlib-js#2808 --------- Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent cb20e58 commit 2bcd3c8

File tree

9 files changed

+11
-11
lines changed

9 files changed

+11
-11
lines changed

lib/node_modules/@stdlib/math/base/special/log/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Logarithm
2222

23-
> Compute the base `b` [logarithm][logarithm].
23+
> Compute the base `b` [logarithm][logarithm] of a double-precision floating-point number.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var log = require( '@stdlib/math/base/special/log' );
3232

3333
#### log( x, b )
3434

35-
Computes the base `b` logarithm of `x`.
35+
Computes the base `b` logarithm of a double-precision floating-point number.
3636

3737
```javascript
3838
var v = log( 100.0, 10.0 );
@@ -113,7 +113,7 @@ for ( i = 0; i < 100; i++ ) {
113113

114114
#### stdlib_base_log( x, b )
115115

116-
Computes the base `b` logarithm of `x`.
116+
Computes the base `b` logarithm of a double-precision floating-point number.
117117

118118
```c
119119
double v = stdlib_base_log( 100.0, 10.0 );

lib/node_modules/@stdlib/math/base/special/log/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( x, b )
3-
Computes the base `b` logarithm of `x`.
3+
Computes the base `b` logarithm of a double-precision floating-point number.
44

55
For negative `b` or `x`, the function returns `NaN`.
66

lib/node_modules/@stdlib/math/base/special/log/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the base `b` logarithm of `x`.
22+
* Computes the base `b` logarithm of a double-precision floating-point number.
2323
*
2424
* @param x - input value
2525
* @param b - base

lib/node_modules/@stdlib/math/base/special/log/include/stdlib/math/base/special/log.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Computes the base b logarithm of x.
30+
* Computes the base `b` logarithm of a double-precision floating-point number.
3131
*/
3232
double stdlib_base_log( const double x, const double b );
3333

lib/node_modules/@stdlib/math/base/special/log/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Compute the base `b` logarithm.
22+
* Compute the base `b` logarithm of a double-precision floating-point number.
2323
*
2424
* @module @stdlib/math/base/special/log
2525
*

lib/node_modules/@stdlib/math/base/special/log/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var ln = require( '@stdlib/math/base/special/ln' );
2626
// MAIN //
2727

2828
/**
29-
* Computes the base `b` logarithm of `x`.
29+
* Computes the base `b` logarithm of a double-precision floating-point number.
3030
*
3131
* @param {NonNegativeNumber} x - input value
3232
* @param {NonNegativeNumber} b - base

lib/node_modules/@stdlib/math/base/special/log/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Computes the base b logarithm of x.
29+
* Computes the base `b` logarithm of a double-precision floating-point number.
3030
*
3131
* @private
3232
* @param {number} x - input value

lib/node_modules/@stdlib/math/base/special/log/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/special/log",
33
"version": "0.0.0",
4-
"description": "Base `b` logarithm.",
4+
"description": "Compute the base `b` logarithm of a double-precision floating-point number.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/math/base/special/log/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#include "stdlib/math/base/special/ln.h"
2121

2222
/**
23-
* Computes the base b logarithm of x.
23+
* Computes the base `b` logarithm of a double-precision floating-point number.
2424
*
2525
* @param x input value
2626
* @param b input value

0 commit comments

Comments
 (0)