Skip to content

Commit 56805e1

Browse files
authored
chore: minor clean-up
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 7d04c37 commit 56805e1

File tree

8 files changed

+9
-18
lines changed

8 files changed

+9
-18
lines changed

lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ console.log( v );
166166
## See Also
167167

168168
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn`][@stdlib/blas/ext/base/dapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each double-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
169-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
169+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
170170
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum.</span>
171171
- <span class="package-name">[`@stdlib/blas/ext/base/ssumkbn`][@stdlib/blas/ext/base/ssumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
172172

lib/node_modules/@stdlib/constants/float32/pi/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,6 @@ Macro for the mathematical constant [π][pi].
108108

109109
<section class="related">
110110

111-
* * *
112-
113-
## See Also
114-
115-
- <span class="package-name">[`@stdlib/constants/float32/fourth-pi`][@stdlib/constants/float32/fourth-pi]</span><span class="delimiter">: </span><span class="description">1/4 times π.</span>
116-
- <span class="package-name">[`@stdlib/constants/float32/half-pi`][@stdlib/constants/float32/half-pi]</span><span class="delimiter">: </span><span class="description">1/2 times π.</span>
117-
- <span class="package-name">[`@stdlib/constants/float32/two-pi`][@stdlib/constants/float32/two-pi]</span><span class="delimiter">: </span><span class="description">2π.</span>
118-
119111
</section>
120112

121113
<!-- /.related -->

lib/node_modules/@stdlib/stats/base/dists/planck/mode/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ for ( i = 0; i < lambda.length; i++ ) {
146146

147147
#### stdlib_base_dists_planck_mode( lambda )
148148

149-
Evaluates the mode for planck distribution.
149+
Returns the [mode][mode] of a Planck distribution with shape parameter `lambda`.
150150

151151
```c
152152
double out = stdlib_base_dists_planck_mode( 0.1 );
@@ -155,7 +155,7 @@ double out = stdlib_base_dists_planck_mode( 0.1 );
155155

156156
The function accepts the following arguments:
157157

158-
- **lambda**: `[in] double` shape parameter
158+
- **lambda**: `[in] double` shape parameter.
159159

160160
```c
161161
double stdlib_base_dists_planck_mode( const double lambda );
@@ -195,7 +195,7 @@ int main( void ) {
195195
for ( i = 0; i < 25; i++ ) {
196196
lambda = random_uniform( 0.1, 10.0 );
197197
y = stdlib_base_dists_planck_mode( lambda );
198-
printf( "lambda: %lf, E(X;λ): %lf\n", lambda, y );
198+
printf( "lambda: %lf, mode(X;λ): %lf\n", lambda, y );
199199
}
200200
}
201201
```

lib/node_modules/@stdlib/stats/base/dists/planck/mode/examples/c/example.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ int main( void ) {
3232
for ( i = 0; i < 25; i++ ) {
3333
lambda = random_uniform( 1.0, 10.0 );
3434
y = stdlib_base_dists_planck_mode( lambda );
35-
printf( "λ: %lf, F(x;λ): %lf\n", lambda , y );
35+
printf( "λ: %lf, mode(X;λ): %lf\n", lambda , y );
3636
}
3737
}

lib/node_modules/@stdlib/stats/base/dists/planck/mode/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-
* Returns the mode for Planck distribution with shape parameter `lambda`.
29+
* Returns the mode for a Planck distribution with shape parameter `lambda`.
3030
*
3131
* @private
3232
* @param {number} lambda - shape parameter

lib/node_modules/@stdlib/stats/base/dists/planck/mode/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
"scripts": {},
2929
"homepage": "https://github.com/stdlib-js/stdlib",
3030
"repository": {
31-
"type": "git",
32-
"url": "git://github.com/stdlib-js/stdlib.git"
31+
"type": "git",
32+
"url": "git://github.com/stdlib-js/stdlib.git"
3333
},
3434
"bugs": {
3535
"url": "https://github.com/stdlib-js/stdlib/issues"

lib/node_modules/@stdlib/stats/base/dists/planck/mode/src/addon.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@
1919
#include "stdlib/stats/base/dists/planck/mode.h"
2020
#include "stdlib/math/base/napi/unary.h"
2121

22-
// cppcheck-suppress shadowFunction
2322
STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_dists_planck_mode )

lib/node_modules/@stdlib/stats/base/dists/planck/mode/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* Returns the mode of a Planck distribution with shape parameter `lambda`.
2424
*
2525
* @param lambda shape parameter
26-
* @return mode or NaN if invalid input
26+
* @return mode
2727
*
2828
* @example
2929
* double y = stdlib_base_dists_planck_mode( 0.1 );

0 commit comments

Comments
 (0)