Skip to content

Commit e7f6b8e

Browse files
committed
code review
1 parent daf92b0 commit e7f6b8e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

packages/circuit-ui/components/ComparisonTable/ComparisonTable.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ Allows users to quickly compare different plans side by side by highlighting key
1919

2020
## Content guidelines
2121

22-
- Keep feature titles short & self-explanatory: Users should understand the feature at a glance without needing extra explanation.
23-
- Use descriptions only when necessary: too much text can overwhelm users.
24-
- When a feature requires additional clarification that wouldn’t fit naturally in the table, consider using a Toggletip. Tooltips should be the exception, not the rule, so use them sparingly. If a feature requires a lengthy explanation, it’s better to link to a help page instead
22+
- Keep feature titles short and self-explanatory: users should understand the feature at a glance without needing extra explanation.
23+
- A feature can have an optional `description` when needed. Use descriptions only when necessary: too much text can overwhelm users.
24+
- When a feature requires additional clarification that wouldn’t fit naturally in the table, you can add a `toggletip` property that could contain a more detailed description of you feature and will appear as a [Toggletip](Components/Toggletip/Docs) component in the table. Tooltips should be the exception, not the rule, so use them sparingly. If a feature requires a lengthy explanation, it’s better to link to a help page instead.

0 commit comments

Comments
 (0)