Skip to content

docs: update descriptions #13438

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 2 commits into from
Jul 12, 2026
Merged

docs: update descriptions #13438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9237b99
docs: use canonical "beta prime" naming in `@stdlib/random/betaprime`
claude Jul 12, 2026
933db3c
docs: use canonical "beta prime" naming in `random/betaprime` scaffol…
claude Jul 12, 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
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/random/betaprime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# Beta Prime Random Numbers

> Generate pseudorandom numbers drawn from a [betaprime][@stdlib/random/base/betaprime] distribution.
> Generate pseudorandom numbers drawn from a [beta prime][@stdlib/random/base/betaprime] distribution.

<section class="usage">

Expand All @@ -32,7 +32,7 @@ var betaprime = require( '@stdlib/random/betaprime' );

#### betaprime( shape, alpha, beta\[, options] )

Returns an [ndarray][@stdlib/ndarray/ctor] containing pseudorandom numbers drawn from a [betaprime][@stdlib/random/base/betaprime] distribution.
Returns an [ndarray][@stdlib/ndarray/ctor] containing pseudorandom numbers drawn from a [beta prime][@stdlib/random/base/betaprime] distribution.

```javascript
var arr = betaprime( [ 3, 3 ], 2.0, 5.0 );
Expand Down Expand Up @@ -106,7 +106,7 @@ var dt = String( getDType( arr ) );

#### betaprime.assign( alpha, beta, out )

Fills an [ndarray][@stdlib/ndarray/ctor] with pseudorandom numbers drawn from a [betaprime][@stdlib/random/base/betaprime] distribution.
Fills an [ndarray][@stdlib/ndarray/ctor] with pseudorandom numbers drawn from a [beta prime][@stdlib/random/base/betaprime] distribution.

```javascript
var zeros = require( '@stdlib/ndarray/zeros' );
Expand All @@ -129,7 +129,7 @@ The method has the following parameters:

#### betaprime.factory( \[options] )

Returns a function for generating pseudorandom numbers drawn from a [betaprime][@stdlib/random/base/betaprime] distribution.
Returns a function for generating pseudorandom numbers drawn from a [beta prime][@stdlib/random/base/betaprime] distribution.

```javascript
var getShape = require( '@stdlib/ndarray/shape' );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/betaprime/lib/factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var policies = {
// MAIN //

/**
* Returns a function for generating pseudorandom numbers drawn from a betaprime distribution.
* Returns a function for generating pseudorandom numbers drawn from a beta prime distribution.
*
* @name factory
* @type {Function}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/betaprime/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Generate pseudorandom numbers drawn from a betaprime distribution.
* Generate pseudorandom numbers drawn from a beta prime distribution.
*
* @module @stdlib/random/betaprime
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/betaprime/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var factory = require( './factory.js' );
// MAIN //

/**
* Returns pseudorandom numbers drawn from a betaprime distribution.
* Returns pseudorandom numbers drawn from a beta prime distribution.
*
* @name betaprime
* @type {Function}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/random/betaprime/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/random/betaprime",
"version": "0.0.0",
"description": "Generate pseudorandom numbers drawn from a betaprime distribution.",
"description": "Generate pseudorandom numbers drawn from a beta prime distribution.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
10 changes: 5 additions & 5 deletions lib/node_modules/@stdlib/random/scripts/scaffolds/binary/scripts/data/betaprime.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@
"default_dtype": "float64",
"default_dtype_kind": "real_floating_point",

"from_desc": "a betaprime distribution",
"readme_from_desc": "a [betaprime][@stdlib/random/base/betaprime] distribution",
"from_desc": "a beta prime distribution",
"readme_from_desc": "a [beta prime][@stdlib/random/base/betaprime] distribution",

"readme_heading": "Beta Prime Random Numbers",
"readme_dtype_kind_desc": "a real-valued floating-point",
"readme_dtype_kind_pkg": "stdlib/ndarray/dtypes",

"repl_text_main_desc": "Returns an ndarray containing pseudorandom numbers drawn from a betaprime distribution.",
"repl_text_assign_desc": "Fills an ndarray with pseudorandom numbers drawn from a betaprime distribution.",
"repl_text_factory_desc": "Returns a function for generating pseudorandom numbers drawn from a betaprime distribution.",
"repl_text_main_desc": "Returns an ndarray containing pseudorandom numbers drawn from a beta prime distribution.",
"repl_text_assign_desc": "Fills an ndarray with pseudorandom numbers drawn from a beta prime distribution.",
"repl_text_factory_desc": "Returns a function for generating pseudorandom numbers drawn from a beta prime distribution.",

"repl_text_param_1_desc": "First shape parameter. If an ndarray, must be broadcast compatible with the specified array shape.",
"repl_text_param_2_desc": "Second shape parameter. If an ndarray, must be broadcast compatible with the specified array shape.",
Expand Down