Skip to content

Commit bd90288

Browse files
committed
Indicate example return values
This commit is based on the possibility that the underlying PRNG may change. Which means that specifying a seed does not guarantee the results over time. To guard against churn, we indicate that the shown return values are possible, but not written in stone.
1 parent 204ca15 commit bd90288

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

lib/node_modules/@stdlib/random/shuffle/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ var myshuffle = shuffle.factory({
111111
});
112112

113113
var out = myshuffle( [ 0, 1, 2, 3, 4 ] );
114-
// returns [ 3, 4, 1, 0, 2 ]
114+
// e.g., returns [ 3, 4, 1, 0, 2 ]
115115
```
116116

117117
By default, the returned functions create shallow copies when shuffling. To override the default `copy` strategy, set the `copy` option.

lib/node_modules/@stdlib/random/shuffle/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
> myshuffle = {{alias}}.factory({ 'seed': 239 });
5858
> var arr = [ 0, 1, 2, 3, 4 ];
5959
> var out = myshuffle( arr )
60-
[ 3, 4, 1, 0, 2 ]
60+
e.g., [ 3, 4, 1, 0, 2 ]
6161

6262
// Use a different copy strategy:
6363
> myshuffle = {{alias}}.factory({ 'copy': 'none', 'seed': 867 });

lib/node_modules/@stdlib/random/shuffle/lib/factory.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ var validate = require( './validate.js' );
4747
* });
4848
* var data = [ 3, 8, 4, 8 ];
4949
* var out = shuffle( data );
50-
* // returns [ 4, 3, 8, 8 ]
50+
* // e.g., returns [ 4, 3, 8, 8 ]
5151
*/
5252
function factory( config ) {
5353
var conf;

0 commit comments

Comments
 (0)