Skip to content

docs: fix inconsistent JSDoc annotations #13959

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

Merged
kgryte merged 3 commits into from
Aug 6, 2026
Merged

docs: fix inconsistent JSDoc annotations #13959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15d33ab
docs: use `@name` JSDoc tag in `random/base/chisquare`
claude Aug 5, 2026
93a9537
docs: annotate generator as `@type {PRNG}` in `random/base/rayleigh`
claude Aug 5, 2026
6b81172
docs: correct `beta` parameter description in `random/base/gumbel`
claude Aug 5, 2026
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/base/chisquare/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var factory = require( './factory.js' );
/**
* Returns a pseudorandom number drawn from a chi-square distribution with degrees of freedom `k`.
*
* @function chisquare
* @name chisquare
* @type {PRNG}
* @param {PositiveNumber} k - degrees of freedom
* @returns {number} pseudorandom number
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/base/gumbel/lib/validate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ var isnan = require( '@stdlib/assert/is-nan' );
*
* @private
* @param {number} mu - mean
* @param {PositiveNumber} beta - shape parameter
* @param {PositiveNumber} beta - scale parameter
* @returns {(Error|null)} error or null
*
* @example
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/base/rayleigh/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var factory = require( './factory.js' );
* Returns a pseudorandom number drawn from a Rayleigh distribution with scale parameter `sigma`.
*
* @name rayleigh
* @type {Function}
* @type {PRNG}
* @param {PositiveNumber} sigma - scale parameter
* @returns {NonNegativeNumber} pseudorandom number
*
Expand Down