Skip to content

Commit 937a616

Browse files
committed
docs: use formatted description instead of raw
Signed-off-by: Akshat Patel <[email protected]>
1 parent 11c65e3 commit 937a616

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

.storybook/preview.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,19 @@ components = components.map(comp => ({
2323
...input,
2424
// Storybook does not seem to display deprecated message currently
2525
// Bypassing this by updating rawdescription
26-
rawdescription: input.deprecated ? `**@Deprecatated**\n\n${input.deprecationMessage}` : input.rawdescription
26+
// Using `description` to display formatted code
27+
rawdescription: input.deprecated ? `**@Deprecatated**\n\n${input.deprecationMessage}` : input.description
2728
})),
2829
// Removes properties
2930
propertiesClass: [],
3031
outputsClass: comp.outputsClass.map((output) => ({
3132
...output,
3233
// Prevents control type appearing as `string`
33-
defaultValue: undefined
34+
defaultValue: undefined,
35+
// Storybook does not seem to display deprecated message currently
36+
// Bypassing this by updating rawdescription
37+
// Using `description` to display formatted code
38+
rawdescription: output.deprecated ? `**@Deprecatated**\n\n${output.deprecationMessage}` : output.description
3439
}))
3540
}));
3641

0 commit comments

Comments
 (0)