Skip to content

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

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.

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

Open
2 tasks done
LAC-Tech opened this issue Apr 17, 2025 · 4 comments
Open
2 tasks done
Labels
Documentation Improvements, additions, or changes to documentation.

Comments

@LAC-Tech
Copy link

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.
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Apr 17, 2025

👋 Hi there! 👋

And thank you for opening your first issue! We will get back to you shortly. 🏃 💨

If you have any further questions while waiting for a response, please join our Gitter channel to chat with project maintainers and other community members.

@kgryte
Copy link
Member

kgryte commented Apr 18, 2025

@LAC-Tech Thanks for raising this issue. This has been addressed in b87254d and should be available in the next release of stdlib.

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Apr 18, 2025
@kgryte kgryte changed the title JSDoc for weibull distribution don't match the website. [BUG]: parameter description for Weibull distribution doesn't match the website Apr 18, 2025
@stdlib-js stdlib-js deleted a comment from stdlib-bot Apr 18, 2025
@stdlib-js stdlib-js deleted a comment from stdlib-bot Apr 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements, additions, or changes to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants