Skip to content

Commit b87254d

Browse files
PlaneshifterPlaneshifter
committed
docs: fix parameter descriptions in Weibull distribution packages
--- 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: passed - 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: passed - 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 4e93083 commit b87254d

File tree

35 files changed

+116
-116
lines changed

35 files changed

+116
-116
lines changed

‎lib/node_modules/@stdlib/random/array/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -821,8 +821,8 @@ interface Namespace {
821821
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
822822
*
823823
* @param len - array length
824-
* @param k - scale parameter
825-
* @param lambda - shape parameter
824+
* @param k - shape parameter
825+
* @param lambda - scale parameter
826826
* @param options - function options
827827
* @returns output array
828828
*

‎lib/node_modules/@stdlib/random/array/weibull/docs/types/index.d.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ interface TernaryFunction extends PRNG {
138138
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
139139
*
140140
* @param len - array length
141-
* @param k - scale parameter
142-
* @param lambda - shape parameter
141+
* @param k - shape parameter
142+
* @param lambda - scale parameter
143143
* @param options - function options
144144
* @returns output array
145145
*/
@@ -148,8 +148,8 @@ interface TernaryFunction extends PRNG {
148148
/**
149149
* Fills an array with pseudorandom numbers drawn from a Weibull distribution.
150150
*
151-
* @param k - scale parameter
152-
* @param lambda - shape parameter
151+
* @param k - shape parameter
152+
* @param lambda - scale parameter
153153
* @param out - output array
154154
* @returns output array
155155
*/
@@ -164,8 +164,8 @@ interface Random extends PRNG {
164164
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
165165
*
166166
* @param len - array length
167-
* @param k - scale parameter
168-
* @param lambda - shape parameter
167+
* @param k - shape parameter
168+
* @param lambda - scale parameter
169169
* @param options - function options
170170
* @returns output array
171171
*
@@ -178,8 +178,8 @@ interface Random extends PRNG {
178178
/**
179179
* Fills an array with pseudorandom numbers drawn from a Weibull distribution.
180180
*
181-
* @param k - scale parameter
182-
* @param lambda - shape parameter
181+
* @param k - shape parameter
182+
* @param lambda - scale parameter
183183
* @param out - output array
184184
* @returns output array
185185
*
@@ -204,8 +204,8 @@ interface Random extends PRNG {
204204
*
205205
* - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution.
206206
*
207-
* @param k - scale parameter
208-
* @param lambda - shape parameter
207+
* @param k - shape parameter
208+
* @param lambda - scale parameter
209209
* @param options - function options
210210
* @throws must provide a valid state
211211
* @returns function for creating arrays
@@ -256,8 +256,8 @@ interface Random extends PRNG {
256256
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
257257
*
258258
* @param len - array length
259-
* @param k - scale parameter
260-
* @param lambda - shape parameter
259+
* @param k - shape parameter
260+
* @param lambda - scale parameter
261261
* @param options - function options
262262
* @returns output array
263263
*

‎lib/node_modules/@stdlib/random/array/weibull/lib/main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ var factory = require( './factory.js' );
3131
* @name weibull
3232
* @type {Function}
3333
* @param {NonNegativeInteger} len - array length
34-
* @param {PositiveNumber} k - scale parameter
35-
* @param {PositiveNumber} lambda - shape parameter
34+
* @param {PositiveNumber} k - shape parameter
35+
* @param {PositiveNumber} lambda - scale parameter
3636
* @param {Options} [options] - options
3737
* @param {string} [options.dtype="float64"] - output array data type
3838
* @throws {TypeError} first argument must be a nonnegative integer

‎lib/node_modules/@stdlib/random/base/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,8 +1017,8 @@ interface Namespace {
10171017
* - If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
10181018
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
10191019
*
1020-
* @param k - scale parameter
1021-
* @param lambda - shape parameter
1020+
* @param k - shape parameter
1021+
* @param lambda - scale parameter
10221022
* @returns pseudorandom number
10231023
*
10241024
* @example

‎lib/node_modules/@stdlib/random/base/weibull/docs/types/index.d.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ interface BinaryFunction extends PRNG {
113113
/**
114114
* Returns a Weibull distributed pseudorandom number.
115115
*
116-
* @param k - scale parameter
117-
* @param lambda - shape parameter
116+
* @param k - shape parameter
117+
* @param lambda - scale parameter
118118
* @returns pseudorandom number
119119
*/
120120
( k: number, lambda: number ): number;
@@ -132,8 +132,8 @@ interface Random extends PRNG {
132132
* - If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
133133
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
134134
*
135-
* @param k - scale parameter
136-
* @param lambda - shape parameter
135+
* @param k - shape parameter
136+
* @param lambda - scale parameter
137137
* @returns pseudorandom number
138138
*
139139
* @example
@@ -149,8 +149,8 @@ interface Random extends PRNG {
149149
*
150150
* - When provided `k` and `lambda`, the returned PRNG returns random variates drawn from the specified distribution.
151151
*
152-
* @param k - scale parameter
153-
* @param lambda - shape parameter
152+
* @param k - shape parameter
153+
* @param lambda - scale parameter
154154
* @param options - function options
155155
* @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
156156
* @param options.seed - pseudorandom number generator seed
@@ -213,8 +213,8 @@ interface Random extends PRNG {
213213
* - If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
214214
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
215215
*
216-
* @param k - scale parameter
217-
* @param lambda - shape parameter
216+
* @param k - shape parameter
217+
* @param lambda - scale parameter
218218
* @returns pseudorandom number
219219
*
220220
* @example

‎lib/node_modules/@stdlib/random/base/weibull/lib/main.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ var factory = require( './factory.js' );
3030
*
3131
* @name weibull
3232
* @type {PRNG}
33-
* @param {PositiveNumber} k - scale parameter
34-
* @param {PositiveNumber} lambda - shape parameter
33+
* @param {PositiveNumber} k - shape parameter
34+
* @param {PositiveNumber} lambda - scale parameter
3535
* @returns {NonNegativeNumber} pseudorandom number
3636
*
3737
* @example

‎lib/node_modules/@stdlib/random/base/weibull/lib/validate.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ var format = require( '@stdlib/string/format' );
3030
* Validates parameters.
3131
*
3232
* @private
33-
* @param {PositiveNumber} k - scale parameter
34-
* @param {PositiveNumber} lambda - shape parameter
33+
* @param {PositiveNumber} k - shape parameter
34+
* @param {PositiveNumber} lambda - scale parameter
3535
* @returns {(Error|null)} error or null
3636
*
3737
* @example

‎lib/node_modules/@stdlib/random/base/weibull/lib/weibull.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ var ln = require( '@stdlib/math/base/special/ln' );
3131
*
3232
* @private
3333
* @param {PRNG} rand - PRNG for generating uniformly distributed numbers
34-
* @param {PositiveNumber} k - scale parameter
35-
* @param {PositiveNumber} lambda - shape parameter
34+
* @param {PositiveNumber} k - shape parameter
35+
* @param {PositiveNumber} lambda - scale parameter
3636
* @returns {NonNegativeNumber} pseudorandom number
3737
*/
3838
function weibull( rand, k, lambda ) {

‎lib/node_modules/@stdlib/random/streams/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3641,8 +3641,8 @@ interface Namespace {
36413641
/**
36423642
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
36433643
*
3644-
* @param k - scale parameter
3645-
* @param lambda - shape parameter
3644+
* @param k - shape parameter
3645+
* @param lambda - scale parameter
36463646
* @param options - stream options
36473647
* @throws `k` must be a positive number
36483648
* @throws `lambda` must be a positive number

‎lib/node_modules/@stdlib/random/streams/weibull/docs/types/index.d.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ declare class RandomStream extends Readable {
8686
/**
8787
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
8888
*
89-
* @param k - scale parameter
90-
* @param lambda - shape parameter
89+
* @param k - shape parameter
90+
* @param lambda - scale parameter
9191
* @param options - stream options
9292
* @throws `k` must be a positive number
9393
* @throws `lambda` must be a positive number
@@ -207,8 +207,8 @@ interface Constructor {
207207
/**
208208
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
209209
*
210-
* @param k - scale parameter
211-
* @param lambda - shape parameter
210+
* @param k - shape parameter
211+
* @param lambda - scale parameter
212212
* @param options - stream options
213213
* @throws `k` must be a positive number
214214
* @throws `lambda` must be a positive number
@@ -236,8 +236,8 @@ interface Constructor {
236236
/**
237237
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
238238
*
239-
* @param k - scale parameter
240-
* @param lambda - shape parameter
239+
* @param k - shape parameter
240+
* @param lambda - scale parameter
241241
* @param options - stream options
242242
* @throws `k` must be a positive number
243243
* @throws `lambda` must be a positive number
@@ -265,8 +265,8 @@ interface Constructor {
265265
/**
266266
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Weibull distribution.
267267
*
268-
* @param k - scale parameter
269-
* @param lambda - shape parameter
268+
* @param k - shape parameter
269+
* @param lambda - scale parameter
270270
* @param options - stream options
271271
* @returns factory function
272272
*
@@ -317,8 +317,8 @@ interface Constructor {
317317
/**
318318
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
319319
*
320-
* @param k - scale parameter
321-
* @param lambda - shape parameter
320+
* @param k - shape parameter
321+
* @param lambda - scale parameter
322322
* @param options - stream options
323323
* @throws `k` must be a positive number
324324
* @throws `lambda` must be a positive number
@@ -347,8 +347,8 @@ interface Constructor {
347347
/**
348348
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
349349
*
350-
* @param k - scale parameter
351-
* @param lambda - shape parameter
350+
* @param k - shape parameter
351+
* @param lambda - scale parameter
352352
* @param options - stream options
353353
* @throws `k` must be a positive number
354354
* @throws `lambda` must be a positive number

0 commit comments

Comments
 (0)