Skip to content

Commit 6114701

Browse files
committed
docs: minor clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 1dc536d commit 6114701

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

lib/node_modules/@stdlib/stats/base/dists/halfnormal/kurtosis/README.md

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

2121
# Kurtosis
2222

23-
> [Half-normal][halfnormal-distribution] distribution [excess kurtosis][kurtosis].
23+
> [Half-normal][half-normal-distribution] distribution [excess kurtosis][kurtosis].
2424
2525
<section class="intro">
2626

27-
The [excess kurtosis][kurtosis] of a [half-normal][halfnormal-distribution] distribution with scale `sigma > 0` is
27+
The [excess kurtosis][kurtosis] of a [half-normal][half-normal-distribution] distribution with scale `sigma > 0` is
2828

2929
<!-- <equation class="equation" label="eq:halfnormal_kurtosis" align="center" raw="\gamma_2 = \frac{8(\pi-3)}{(\pi-2)^2}" alt="Excess kurtosis for a half-normal distribution."> -->
3030

@@ -53,7 +53,7 @@ var kurtosis = require( '@stdlib/stats/base/dists/halfnormal/kurtosis' );
5353

5454
#### kurtosis( sigma )
5555

56-
Returns the [excess kurtosis][kurtosis] of a [half-normal][halfnormal-distribution] distribution with scale parameter `sigma`.
56+
Returns the [excess kurtosis][kurtosis] of a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`.
5757

5858
```javascript
5959
var x = kurtosis( 1.0 );
@@ -128,7 +128,7 @@ logEachMap( 'σ: %0.4f, Kurt(X;σ): %0.4f', sigma, kurtosis );
128128

129129
#### stdlib_base_dists_halfnormal_kurtosis( sigma )
130130

131-
Returns the [excess kurtosis][kurtosis] of a [half-normal][halfnormal-distribution] distribution with scale parameter `sigma`.
131+
Returns the [excess kurtosis][kurtosis] of a [half-normal][half-normal-distribution] distribution with scale parameter `sigma`.
132132

133133
```c
134134
double out = stdlib_base_dists_halfnormal_kurtosis( 1.0 );
@@ -204,7 +204,7 @@ int main( void ) {
204204

205205
<section class="links">
206206

207-
[halfnormal-distribution]: https://en.wikipedia.org/wiki/Half-normal_distribution
207+
[half-normal-distribution]: https://en.wikipedia.org/wiki/Half-normal_distribution
208208

209209
[kurtosis]: https://en.wikipedia.org/wiki/Kurtosis
210210

lib/node_modules/@stdlib/stats/base/dists/halfnormal/kurtosis/docs/repl.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11

2-
{{alias}}( sigma )
2+
{{alias}}( σ )
33
Returns the excess kurtosis of a half-normal distribution with
4-
scale parameter `sigma`.
4+
scale parameter `σ`.
55

66
If provided `NaN` as any argument, the function returns `NaN`.
77

8-
If provided `sigma <= 0`, the function returns `NaN`.
8+
If provided `σ <= 0`, the function returns `NaN`.
99

1010
Parameters
1111
----------
12-
13-
sigma: number
12+
σ: number
1413
Scale parameter.
1514

1615
Returns

0 commit comments

Comments
 (0)