Skip to content

[BUG]: parameter description for Weibull distribution doesn't match the website #6702

Open
@LAC-Tech

Description

@LAC-Tech

Description

https://stdlib.io/docs/api/latest/@stdlib/random/base/weibull

Here we have:

"Returns a pseudorandom number drawn from a Weibull distribution with shape parameter k and scale parameter lambda."

However, in the JSDoc I accessed in my editor, I got:

/**
* Interface for generating Weibull distributed pseudorandom numbers without pre-specified parameter values.
*/
interface BinaryFunction extends PRNG {
	/**
	* Returns a Weibull distributed pseudorandom number.
	*
	* @param k - scale parameter
	* @param lambda - shape parameter
	* @returns pseudorandom number
	*/
	( k: number, lambda: number ): number;
}

Here k is erroneously described as scale, and lambda is erroneously described as shape.

Related Issues

Related issues # , # , and # .

Questions

No.

Demo

No response

Reproduction

- a
- b
- c

Expected Results

Actual Results

Version

No response

Environments

N/A

Browser Version

No response

Node.js / npm Version

No response

Platform

No response

Checklist

  • Read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements, additions, or changes to documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions