Skip to content

chore: remove extra space in parameter descriptions #13654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Planeshifter wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

chore: remove extra space in parameter descriptions #13654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/betaprime/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from a beta prime distribution.
*
* @param {PositiveNumber} alpha - first shape parameter
* @param {PositiveNumber} beta - second shape parameter
* @param {PositiveNumber} beta - second shape parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/random/iter/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ interface Namespace {
* Returns an iterator for generating pseudorandom numbers drawn from an Erlang distribution.
*
* @param k - shape parameter
* @param lambda - rate parameter
* @param lambda - rate parameter
* @param options - function options
* @throws `k` must be a positive integer
* @throws `lambda` must be a positive number
Expand Down Expand Up @@ -630,7 +630,7 @@ interface Namespace {
* Returns an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution.
*
* @param alpha - shape parameter
* @param beta - scale parameter
* @param beta - scale parameter
* @param options - function options
* @throws `alpha` must be a positive number
* @throws `beta` must be a positive number
Expand Down Expand Up @@ -658,7 +658,7 @@ interface Namespace {
* Returns an iterator for generating pseudorandom numbers drawn from a Kumaraswamy's double bounded distribution.
*
* @param a - first shape parameter
* @param b - second shape parameter
* @param b - second shape parameter
* @param options - function options
* @throws `a` must be a positive number
* @throws `b` must be a positive number
Expand Down Expand Up @@ -1183,7 +1183,7 @@ interface Namespace {
* Returns an iterator for generating pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param lambda - shape parameter
* @param options - function options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/erlang/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ interface Iterator<T> extends TypedIterator<T> {
* Returns an iterator for generating pseudorandom numbers drawn from an Erlang distribution.
*
* @param k - shape parameter
* @param lambda - rate parameter
* @param lambda - rate parameter
* @param options - function options
* @throws `k` must be a positive integer
* @throws `lambda` must be a positive number
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/erlang/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from an Erlang distribution.
*
* @param {PositiveInteger} k - shape parameter
* @param {PositiveNumber} lambda - rate parameter
* @param {PositiveNumber} lambda - rate parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/frechet/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@
// MAIN //

/**
* Returns an iterator for generating pseudorandom numbers drawn from a Fréchet distribution.

Check warning on line 44 in lib/node_modules/@stdlib/random/iter/frechet/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unknown word: "échet"
*
* @param {PositiveNumber} alpha - shape parameter
* @param {PositiveNumber} s - rate parameter
* @param {PositiveNumber} s - rate parameter
* @param {number} m - location parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/gamma/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from a gamma distribution.
*
* @param {PositiveNumber} alpha - shape parameter
* @param {PositiveNumber} beta - rate parameter
* @param {PositiveNumber} beta - rate parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/invgamma/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ interface Iterator<T> extends TypedIterator<T> {
* Returns an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution.
*
* @param alpha - shape parameter
* @param beta - scale parameter
* @param beta - scale parameter
* @param options - function options
* @throws `alpha` must be a positive number
* @throws `beta` must be a positive number
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/invgamma/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from an inverse gamma distribution.
*
* @param {PositiveNumber} alpha - shape parameter
* @param {PositiveNumber} beta - scale parameter
* @param {PositiveNumber} beta - scale parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/kumaraswamy/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ interface Iterator<T> extends TypedIterator<T> {
* Returns an iterator for generating pseudorandom numbers drawn from a Kumaraswamy's double bounded distribution.
*
* @param a - first shape parameter
* @param b - second shape parameter
* @param b - second shape parameter
* @param options - function options
* @throws `a` must be a positive number
* @throws `b` must be a positive number
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/kumaraswamy/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from a Kumaraswamy's double bounded distribution.
*
* @param {PositiveNumber} a - first shape parameter
* @param {PositiveNumber} b - second shape parameter
* @param {PositiveNumber} b - second shape parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/pareto-type1/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from a Pareto (Type I) distribution.
*
* @param {PositiveNumber} alpha - shape parameter
* @param {PositiveNumber} beta - scale parameter
* @param {PositiveNumber} beta - scale parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/weibull/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ interface Iterator<T> extends TypedIterator<T> {
* Returns an iterator for generating pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param lambda - shape parameter
* @param options - function options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/iter/weibull/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var format = require( '@stdlib/string/format' );
* Returns an iterator for generating pseudorandom numbers drawn from a Weibull distribution.
*
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {Options} [options] - function options
* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/binomial/quantile/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var searchRight = require( './search_right.js' );
*
* @param {Probability} r - input value
* @param {NonNegativeInteger} n - number of trials
* @param {Probability} p - success probability
* @param {Probability} p - success probability
* @returns {NonNegativeInteger} evaluated quantile function
*
* @example
Expand Down