Skip to content

Commit ee1f1a7

Browse files
committed
docs: fix wrong section order in stats/base/dists and stats/strided READMEs
--- 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: na - 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 0249e24 commit ee1f1a7

12 files changed

Lines changed: 96 additions & 110 deletions

File tree

lib/node_modules/@stdlib/stats/base/dists/bernoulli/entropy/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,6 @@ logEachMap( 'p: %0.4f, H(X;p): %0.4f', p, entropy );
119119

120120
<!-- /.examples -->
121121

122-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
123-
124-
<section class="references">
125-
126-
</section>
127-
128-
<!-- /.references -->
129-
130122
<!-- C interface documentation. -->
131123

132124
* * *
@@ -214,6 +206,14 @@ int main( void ) {
214206

215207
<!-- /.c -->
216208

209+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
210+
211+
<section class="references">
212+
213+
</section>
214+
215+
<!-- /.references -->
216+
217217
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
218218

219219
<section class="related">

lib/node_modules/@stdlib/stats/base/dists/bernoulli/mean/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,6 @@ logEachMap( 'p: %0.4f, E(X;p): %0.4f', p, mean );
119119

120120
<!-- /.examples -->
121121

122-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
123-
124-
<section class="references">
125-
126-
</section>
127-
128-
<!-- /.references -->
129-
130122
<!-- C interface documentation. -->
131123

132124
* * *
@@ -214,6 +206,14 @@ int main( void ) {
214206

215207
<!-- /.c -->
216208

209+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
210+
211+
<section class="references">
212+
213+
</section>
214+
215+
<!-- /.references -->
216+
217217
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
218218

219219
<section class="related">

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

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -124,22 +124,6 @@ logEachMap( 'σ: %lf, E(X;σ): %lf', sigma, mean );
124124

125125
<!-- /.examples -->
126126

127-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
128-
129-
<section class="references">
130-
131-
</section>
132-
133-
<!-- /.references -->
134-
135-
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
136-
137-
<section class="related">
138-
139-
</section>
140-
141-
<!-- /.related -->
142-
143127
<!-- Section for C API documentation. -->
144128

145129
* * *
@@ -225,6 +209,14 @@ int main( void ) {
225209

226210
<!-- /.c -->
227211

212+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
213+
214+
<section class="references">
215+
216+
</section>
217+
218+
<!-- /.references -->
219+
228220
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
229221

230222
<section class="related">

lib/node_modules/@stdlib/stats/base/dists/normal/mean/README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -128,22 +128,6 @@ logEachMap( 'µ: %0.4f, σ: %0.4f, E(X;µ,σ): %0.4f', mu, sigma, mean );
128128

129129
<!-- /.examples -->
130130

131-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
132-
133-
<section class="references">
134-
135-
</section>
136-
137-
<!-- /.references -->
138-
139-
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
140-
141-
<section class="related">
142-
143-
</section>
144-
145-
<!-- /.related -->
146-
147131
<!-- Section to include C API documentation. -->
148132

149133
<section class="c">
@@ -230,6 +214,14 @@ int main( void ) {
230214

231215
<!-- /.c -->
232216

217+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
218+
219+
<section class="references">
220+
221+
</section>
222+
223+
<!-- /.references -->
224+
233225
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
234226

235227
<section class="related">

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,6 @@ logEachMap( 'λ: %0.4f, H(X;λ): %0.4f', lambda, entropy );
111111

112112
<!-- /.examples -->
113113

114-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
115-
116-
<section class="references">
117-
118-
</section>
119-
120-
<!-- /.references -->
121-
122114
<!-- C interface documentation. -->
123115

124116
* * *
@@ -211,6 +203,14 @@ int main( void ) {
211203

212204
<!-- /.c -->
213205

206+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
207+
208+
<section class="references">
209+
210+
</section>
211+
212+
<!-- /.references -->
213+
214214
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
215215

216216
<section class="related">

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,6 @@ logEachMap( 'λ: %0.4f, E(X;λ): %0.4f', lambda, mean );
111111

112112
<!-- /.examples -->
113113

114-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
115-
116-
<section class="references">
117-
118-
</section>
119-
120-
<!-- /.references -->
121-
122114
<!-- C interface documentation. -->
123115

124116
* * *
@@ -211,6 +203,14 @@ int main( void ) {
211203

212204
<!-- /.c -->
213205

206+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
207+
208+
<section class="references">
209+
210+
</section>
211+
212+
<!-- /.references -->
213+
214214
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
215215

216216
<section class="related">

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,6 @@ logEachMap( 'λ: %0.4f, Median(X;λ): %0.4f', lambda, median );
111111

112112
<!-- /.examples -->
113113

114-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
115-
116-
<section class="references">
117-
118-
</section>
119-
120-
<!-- /.references -->
121-
122114
<!-- C interface documentation. -->
123115

124116
* * *
@@ -211,6 +203,14 @@ int main( void ) {
211203

212204
<!-- /.c -->
213205

206+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
207+
208+
<section class="references">
209+
210+
</section>
211+
212+
<!-- /.references -->
213+
214214
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
215215

216216
<section class="related">

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,6 @@ logEachMap( 't: %0.4f, λ: %0.4f, M_X(t;λ): %0.4f', t, lambda, mgf );
129129

130130
<!-- /.examples -->
131131

132-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
133-
134-
<section class="references">
135-
136-
</section>
137-
138-
<!-- /.references -->
139-
140132
<!-- C interface documentation. -->
141133

142134
* * *
@@ -233,6 +225,14 @@ int main( void ) {
233225

234226
<!-- /.c -->
235227

228+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
229+
230+
<section class="references">
231+
232+
</section>
233+
234+
<!-- /.references -->
235+
236236
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
237237

238238
<section class="related">

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,6 @@ logEachMap( 'λ: %0.4f, mode(X;λ): %0.4f', lambda, mode );
109109

110110
<!-- /.examples -->
111111

112-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
113-
114-
<section class="references">
115-
116-
</section>
117-
118-
<!-- /.references -->
119-
120112
<!-- C interface documentation. -->
121113

122114
* * *
@@ -208,6 +200,14 @@ int main( void ) {
208200

209201
<!-- /.c -->
210202

203+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
204+
205+
<section class="references">
206+
207+
</section>
208+
209+
<!-- /.references -->
210+
211211
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
212212

213213
<section class="related">

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,6 @@ logEachMap( 'λ: %0.4f, SD(X;λ): %0.4f', lambda, stdev );
111111

112112
<!-- /.examples -->
113113

114-
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
115-
116-
<section class="references">
117-
118-
</section>
119-
120-
<!-- /.references -->
121-
122114
<!-- C interface documentation. -->
123115

124116
* * *
@@ -211,6 +203,14 @@ int main( void ) {
211203

212204
<!-- /.c -->
213205

206+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
207+
208+
<section class="references">
209+
210+
</section>
211+
212+
<!-- /.references -->
213+
214214
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
215215

216216
<section class="related">

0 commit comments

Comments
 (0)