Skip to content

Commit fca86e7

Browse files
committed
chore: docs comments
1 parent 51a983d commit fca86e7

1 file changed

Lines changed: 18 additions & 6 deletions

File tree

apps/site/types/partners.ts

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,29 @@ import type { ReactElement, SVGProps } from 'react';
22

33
export type Partners = {
44
id: string;
5-
// The name of the partner
5+
/**
6+
* The name of the partner
7+
*/
68
name: string;
7-
// A logo to render on the partners page
9+
/**
10+
* A logo to render on the partners page
11+
*/
812
logo: ReactElement<SVGProps<SVGSVGElement>>;
9-
// The promoted link to their website or social media
13+
/**
14+
* The promoted link to their website or social media
15+
*/
1016
href: string;
11-
// The categories this partner belongs to
17+
/**
18+
* The categories this partner belongs to
19+
*/
1220
categories: Array<PartnerCategory>;
13-
// An optional description of the partner
21+
/**
22+
* An optional description of the partner
23+
*/
1424
description?: string;
15-
// The weight of the partner, used for random selection
25+
/**
26+
* The weight of the partner, used for random selection
27+
*/
1628
weight: number;
1729
};
1830

0 commit comments

Comments
 (0)