Skip to content

refactor: align stream constructor parameter names with documentation in random/streams #12624

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

refactor: align stream constructor parameter names with documentation in random/streams #12624

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
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
* Class for creating readable streams which generate a stream of pseudorandom numbers drawn from a chi-square distribution.
*/
declare class RandomStream extends Readable {
/**

Check failure on line 86 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: RandomStream is not defined

Check failure on line 86 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: RandomStream is not defined
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a chi-square distribution.
*
* @param k - degrees of freedom
Expand All @@ -108,7 +108,7 @@
*
* stream.pipe( inspectStream( log ) );
*/
constructor( p: number, options?: Options );
constructor( k: number, options?: Options );

/**
* Destruction state.
Expand Down Expand Up @@ -182,7 +182,7 @@
*/
_read( size: number ): void;

/**

Check failure on line 185 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: RandomStream is not defined
* Gracefully destroys a stream, providing backward compatibility.
*
* @param error - error
Expand Down Expand Up @@ -227,7 +227,7 @@
*
* stream.pipe( inspectStream( log ) );
*/
new( p: number, options?: Options ): RandomStream; // newable
new( k: number, options?: Options ): RandomStream; // newable

/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a chi-square distribution.
Expand All @@ -254,9 +254,9 @@
*
* stream.pipe( inspectStream( log ) );
*/
( p: number, options?: Options ): RandomStream; // callable
( k: number, options?: Options ): RandomStream; // callable

/**

Check failure on line 259 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: RandomStream is not defined
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a chi-square distribution.
*
* @param k - degrees of freedom
Expand All @@ -281,9 +281,9 @@
* streams.push( createStream() );
* }
*/
factory( p: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;
factory( k: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;

Check warning on line 284 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected any. Specify a different type

/**

Check failure on line 286 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: RandomStream is not defined
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a chi-square distribution.
*
* @param options - stream options
Expand All @@ -306,9 +306,9 @@
* streams.push( createStream( 0.7 ) );
* }
*/
factory( options?: Options ): ( p: number ) => RandomStream;
factory( options?: Options ): ( k: number ) => RandomStream;

/**

Check failure on line 311 in lib/node_modules/@stdlib/random/streams/chisquare/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: RandomStream is not defined
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a chi-square distribution.
*
* @param k - degrees of freedom
Expand All @@ -333,7 +333,7 @@
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
objectMode( p: number, options?: Options ): RandomStream;
objectMode( k: number, options?: Options ): RandomStream;
}

/**
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/random/streams/exponential/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ declare class RandomStream extends Readable {
*
* stream.pipe( inspectStream( log ) );
*/
constructor( p: number, options?: Options );
constructor( lambda: number, options?: Options );

/**
* Destruction state.
Expand Down Expand Up @@ -227,7 +227,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
new( p: number, options?: Options ): RandomStream; // newable
new( lambda: number, options?: Options ): RandomStream; // newable

/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from an exponential distribution.
Expand All @@ -254,7 +254,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
( p: number, options?: Options ): RandomStream; // callable
( lambda: number, options?: Options ): RandomStream; // callable

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from an exponential distribution.
Expand All @@ -281,7 +281,7 @@ interface Constructor {
* streams.push( createStream() );
* }
*/
factory( p: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;
factory( lambda: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from an exponential distribution.
Expand All @@ -306,7 +306,7 @@ interface Constructor {
* streams.push( createStream( 0.7 ) );
* }
*/
factory( options?: Options ): ( p: number ) => RandomStream;
factory( options?: Options ): ( lambda: number ) => RandomStream;

/**
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from an exponential distribution.
Expand All @@ -333,7 +333,7 @@ interface Constructor {
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
objectMode( p: number, options?: Options ): RandomStream;
objectMode( lambda: number, options?: Options ): RandomStream;
}

/**
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/random/streams/poisson/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ declare class RandomStream extends Readable {
*
* stream.pipe( inspectStream( log ) );
*/
constructor( p: number, options?: Options );
constructor( lambda: number, options?: Options );

/**
* Destruction state.
Expand Down Expand Up @@ -227,7 +227,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
new( p: number, options?: Options ): RandomStream; // newable
new( lambda: number, options?: Options ): RandomStream; // newable

/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Poisson distribution.
Expand All @@ -254,7 +254,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
( p: number, options?: Options ): RandomStream; // callable
( lambda: number, options?: Options ): RandomStream; // callable

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Poisson distribution.
Expand All @@ -281,7 +281,7 @@ interface Constructor {
* streams.push( createStream() );
* }
*/
factory( p: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;
factory( lambda: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Poisson distribution.
Expand All @@ -306,7 +306,7 @@ interface Constructor {
* streams.push( createStream( 0.7 ) );
* }
*/
factory( options?: Options ): ( p: number ) => RandomStream;
factory( options?: Options ): ( lambda: number ) => RandomStream;

/**
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Poisson distribution.
Expand All @@ -333,7 +333,7 @@ interface Constructor {
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
objectMode( p: number, options?: Options ): RandomStream;
objectMode( lambda: number, options?: Options ): RandomStream;
}

/**
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/random/streams/rayleigh/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ declare class RandomStream extends Readable {
*
* stream.pipe( inspectStream( log ) );
*/
constructor( p: number, options?: Options );
constructor( sigma: number, options?: Options );

/**
* Destruction state.
Expand Down Expand Up @@ -227,7 +227,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
new( p: number, options?: Options ): RandomStream; // newable
new( sigma: number, options?: Options ): RandomStream; // newable

/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Rayleigh distribution.
Expand All @@ -254,7 +254,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
( p: number, options?: Options ): RandomStream; // callable
( sigma: number, options?: Options ): RandomStream; // callable

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Rayleigh distribution.
Expand All @@ -281,7 +281,7 @@ interface Constructor {
* streams.push( createStream() );
* }
*/
factory( p: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;
factory( sigma: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Rayleigh distribution.
Expand All @@ -306,7 +306,7 @@ interface Constructor {
* streams.push( createStream( 0.7 ) );
* }
*/
factory( options?: Options ): ( p: number ) => RandomStream;
factory( options?: Options ): ( sigma: number ) => RandomStream;

/**
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Rayleigh distribution.
Expand All @@ -333,7 +333,7 @@ interface Constructor {
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
objectMode( p: number, options?: Options ): RandomStream;
objectMode( sigma: number, options?: Options ): RandomStream;
}

/**
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/random/streams/t/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ declare class RandomStream extends Readable {
*
* stream.pipe( inspectStream( log ) );
*/
constructor( k: number, options?: Options );
constructor( v: number, options?: Options );

/**
* Destruction state.
Expand Down Expand Up @@ -227,7 +227,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
new( k: number, options?: Options ): RandomStream; // newable
new( v: number, options?: Options ): RandomStream; // newable

/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Student's t distribution.
Expand All @@ -254,7 +254,7 @@ interface Constructor {
*
* stream.pipe( inspectStream( log ) );
*/
( k: number, options?: Options ): RandomStream; // callable
( v: number, options?: Options ): RandomStream; // callable

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Student's t distribution.
Expand All @@ -281,7 +281,7 @@ interface Constructor {
* streams.push( createStream() );
* }
*/
factory( k: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;
factory( v: number, options?: Options ): ( ...args: Array<any> ) => RandomStream;

/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Student's t distribution.
Expand All @@ -306,7 +306,7 @@ interface Constructor {
* streams.push( createStream( 2.0 ) );
* }
*/
factory( options?: Options ): ( k: number ) => RandomStream;
factory( options?: Options ): ( v: number ) => RandomStream;

/**
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Student's t distribution.
Expand All @@ -333,7 +333,7 @@ interface Constructor {
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
objectMode( k: number, options?: Options ): RandomStream;
objectMode( v: number, options?: Options ): RandomStream;
}

/**
Expand Down
Loading