WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit f4cbb27

Browse files
committed
docs: clean up TSDocs
1 parent 2670e46 commit f4cbb27

File tree

4 files changed

+14
-15
lines changed

4 files changed

+14
-15
lines changed

src/PrismicImage.tsx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,10 @@ export type PrismicImageProps = Omit<
6464
} & (
6565
| {
6666
/**
67-
* Widths used to build a `srcset` value for the image field.
67+
* Widths (in pixels) used to build a `srcset` value for the image field.
6868
*
69-
* If a `widths` prop is not given or `"defaults"` is passed, the
70-
* following widths will be used: 640, 750, 828, 1080, 1200, 1920, 2048,
71-
* 3840.
69+
* If omitted or set to `"defaults"`, the following widths will be used:
70+
* 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
7271
*
7372
* If the image field contains responsive views, each responsive view
7473
* can be used as a width in the resulting `srcset` by passing

src/PrismicLink.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface LinkProps {
3737
*/
3838
rel?: string;
3939

40-
/** Children for the component. * */
40+
/** Children for the component. */
4141
children?: ReactNode;
4242
}
4343

@@ -56,13 +56,13 @@ export type PrismicLinkProps<
5656
rel?: string | AsLinkAttrsConfig["rel"];
5757

5858
/**
59-
* The Link Resolver used to resolve links.
59+
* The link resolver used to resolve links.
6060
*
6161
* @remarks
62-
* If your app uses Route Resolvers when querying for your Prismic
63-
* repository's content, a Link Resolver does not need to be provided.
62+
* If your app uses route resolvers when querying for your Prismic
63+
* repository's content, a link resolver does not need to be provided.
6464
*
65-
* @see Learn about Link Resolvers and Route Resolvers {@link https://prismic.io/docs/routes}
65+
* @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
6666
*/
6767
linkResolver?: LinkResolverFunction;
6868

src/PrismicRichText.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ export type PrismicRichTextProps = {
4747
field: RichTextField | null | undefined;
4848

4949
/**
50-
* The Link Resolver used to resolve links.
50+
* The link resolver used to resolve links.
5151
*
5252
* @remarks
53-
* If your app uses Route Resolvers when querying for your Prismic
54-
* repository's content, a Link Resolver does not need to be provided.
53+
* If your app uses route resolvers when querying for your Prismic
54+
* repository's content, a link resolver does not need to be provided.
5555
*
56-
* @see Learn about Link Resolvers and Route Resolvers {@link https://prismic.io/docs/routes}
56+
* @see Learn about link resolvers and route resolvers {@link https://prismic.io/docs/routes}
5757
*/
5858
linkResolver?: LinkResolverFunction;
5959

src/SliceZone.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { DEV } from "esm-env";
55
/**
66
* Returns the type of a `SliceLike` type.
77
*
8-
* @typeParam Slice - The Slice from which the type will be extracted.
8+
* @typeParam TSlice - The slice from which the type will be extracted.
99
*/
1010
type ExtractSliceType<TSlice extends SliceLike> = TSlice extends Slice
1111
? TSlice["slice_type"]
@@ -203,7 +203,7 @@ export const TODOSliceComponent = <TSlice extends SliceLike>({
203203
};
204204

205205
/**
206-
* Renders a slices in a slice zone as React components.
206+
* Renders slices in a slice zone as React components.
207207
*
208208
* @example
209209
*

0 commit comments

Comments
 (0)