Skip to content

Commit 5e8b511

Browse files
committed
Fix value, add space, and use Oxford comma
1 parent 272f7b9 commit 5e8b511

File tree

1 file changed

+8
-8
lines changed
  • lib/node_modules/@stdlib/random/shuffle/docs/types

1 file changed

+8
-8
lines changed

lib/node_modules/@stdlib/random/shuffle/docs/types/index.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,19 @@ import { ArrayLike } from '@stdlib/types/array';
2727
*/
2828
interface Options {
2929
/**
30-
* String indicating whether to return a copy (`deep`,`shallow` or `none`; default: 'shallow')
30+
* String indicating whether to return a copy (`deep`, `shallow`, or `none`; default: 'shallow')
3131
*/
32-
copy?: 'deep' | 'shuffle' | 'none';
32+
copy?: 'deep' | 'shallow' | 'none';
3333
}
3434

3535
/**
3636
* Interface defining `factory` options.
3737
*/
3838
interface Config {
3939
/**
40-
* Default copy option (`deep`,`shallow` or `none`; default: 'shallow')
40+
* Default copy option (`deep`, `shallow`, or `none`; default: 'shallow')
4141
*/
42-
copy?: 'deep' | 'shuffle' | 'none';
42+
copy?: 'deep' | 'shallow' | 'none';
4343

4444
/**
4545
* Integer-valued seed.
@@ -52,7 +52,7 @@ interface Config {
5252
*
5353
* @param arr - array-like object to shuffle
5454
* @param options - function options
55-
* @param options.copy - string indicating whether to return a copy (`deep`,`shallow` or `none`)
55+
* @param options.copy - string indicating whether to return a copy (`deep`, `shallow`, or `none`)
5656
* @throws must provide valid options
5757
* @returns the shuffled array-like object
5858
*
@@ -80,7 +80,7 @@ interface Shuffle {
8080
*
8181
* @param arr - array-like object to shuffle
8282
* @param options - function options
83-
* @param options.copy - string indicating whether to return a copy (`deep`,`shallow` or `none`; default: 'shallow')
83+
* @param options.copy - string indicating whether to return a copy (`deep`, `shallow`, or `none`; default: 'shallow')
8484
* @throws must provide valid options
8585
* @returns the shuffled array-like object
8686
*
@@ -104,7 +104,7 @@ interface Shuffle {
104104
*
105105
* @param config - function options
106106
* @param config.seed - integer-valued seed
107-
* @param config.copy - default copy option (`deep`, `shallow` or `none`; default: 'shallow')
107+
* @param config.copy - default copy option (`deep`, `shallow`, or `none`; default: 'shallow')
108108
* @throws must provide valid options
109109
* @returns shuffle function
110110
*
@@ -124,7 +124,7 @@ interface Shuffle {
124124
*
125125
* @param arr - array-like object to shuffle
126126
* @param options - function options
127-
* @param options.copy - string indicating whether to return a copy (`deep`,`shallow` or `none`; default: 'shallow')
127+
* @param options.copy - string indicating whether to return a copy (`deep`, `shallow`, or `none`; default: 'shallow')
128128
* @throws must provide valid options
129129
* @returns the shuffled array-like object
130130
*

0 commit comments

Comments
 (0)