Skip to content

Commit f73c103

Browse files
committed
doc: comment improvements
1 parent ae69430 commit f73c103

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/patterns.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,7 @@ export const number: NumberPattern = numberChainable(when(isNumber));
933933
*
934934
* @example
935935
* match(value)
936-
* .with(P.bigint.between(0, 10), () => '0 <= numbers <= 10')
936+
* .with(P.bigint.between(0, 10), () => '0 <= bigints <= 10')
937937
*/
938938
const betweenBigInt = <
939939
input,
@@ -952,7 +952,7 @@ const betweenBigInt = <
952952
*
953953
* @example
954954
* match(value)
955-
* .with(P.bigint.lt(10), () => 'numbers < 10')
955+
* .with(P.bigint.lt(10), () => 'bigints < 10')
956956
*/
957957
const ltBigInt = <input, const max extends bigint>(
958958
max: max
@@ -966,7 +966,7 @@ const ltBigInt = <input, const max extends bigint>(
966966
*
967967
* @example
968968
* match(value)
969-
* .with(P.bigint.gt(10), () => 'numbers > 10')
969+
* .with(P.bigint.gt(10), () => 'bigints > 10')
970970
*/
971971
const gtBigInt = <input, const min extends bigint>(
972972
min: min
@@ -1077,7 +1077,7 @@ export const symbol: SymbolPattern = chainable(when(isSymbol));
10771077
* [Read the documentation for `P.nullish` on GitHub](https://github.com/gvergnaud/ts-pattern#nullish-wildcard)
10781078
*
10791079
* @example
1080-
* .with(P.nullish, () => 'will match on null or undefined')
1080+
* .with(P.nullish, (x) => `${x} is null or undefined`)
10811081
*/
10821082
export const nullish: NullishPattern = chainable(when(isNullish));
10831083

@@ -1087,7 +1087,7 @@ export const nullish: NullishPattern = chainable(when(isNullish));
10871087
* [Read the documentation for `P.nonNullable` on GitHub](https://github.com/gvergnaud/ts-pattern#nonNullable-wildcard)
10881088
*
10891089
* @example
1090-
* .with(P.nonNullable, () => 'will match on null or undefined')
1090+
* .with(P.nonNullable, (x) => `${x} isn't null nor undefined`)
10911091
*/
10921092
export const nonNullable: NonNullablePattern = chainable(when(isNonNullable));
10931093

0 commit comments

Comments
 (0)