Skip to content

Commit a88e382

Browse files
committed
Update doc headings from '###' to '##' in Types.ts
1 parent d0c10ab commit a88e382

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

packages/common/src/Types.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import * as Kysely from "kysely";
1111
*
1212
* A predicate starts with an 'is' prefix, e.g., `isEven`.
1313
*
14-
* ### Example
14+
* ## Example
1515
*
1616
* ```ts
1717
* const isEven: Predicate<number> = (n) => n % 2 === 0;
@@ -27,7 +27,7 @@ export type Predicate<T> = (value: T) => boolean;
2727
*
2828
* Useful for callbacks that need both the element and its position.
2929
*
30-
* ### Example
30+
* ## Example
3131
*
3232
* ```ts
3333
* const isEvenIndex: PredicateWithIndex<string> = (value, index) =>
@@ -42,7 +42,7 @@ export type PredicateWithIndex<T> = (value: T, index: number) => boolean;
4242
/**
4343
* A type guard function that refines type `A` to a narrower type `B`.
4444
*
45-
* ### Example
45+
* ## Example
4646
*
4747
* ```ts
4848
* type Animal = { name: string };
@@ -66,7 +66,7 @@ export type Refinement<in A, out B extends A> = (a: A) => a is B;
6666
* Useful for callbacks that need both the element and its position while
6767
* maintaining type narrowing.
6868
*
69-
* ### Example
69+
* ## Example
7070
*
7171
* ```ts
7272
* type Item = { type: "number" | "string"; value: unknown };
@@ -90,7 +90,7 @@ export type RefinementWithIndex<in A, out B extends A> = (
9090
* For each property in `T`, if `null` is a valid value for that property, the
9191
* property will be made optional in the resulting type.
9292
*
93-
* ### Example
93+
* ## Example
9494
*
9595
* ```ts
9696
* type Example = {
@@ -153,7 +153,7 @@ export type WidenLiteral<T extends Literal> = T extends string
153153
* This utility forces TypeScript to "flatten" an intersection type into a
154154
* single object type so that tooltips and error messages are easier to read.
155155
*
156-
* ### Example
156+
* ## Example
157157
*
158158
* ```ts
159159
* type A = { a: string } & { b: number };

0 commit comments

Comments
 (0)