hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 02:07:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

context_help.md: Make table column widths even

Browse Source
This commit is contained in:
Karol Lewandowski 2024-05-23 10:58:21 +02:00
parent addd1312f6
commit 4e9a80ff6b
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
topics/ui/principles/context_help.md
View File

@ -80,9 +80,16 @@ Do not use context help to explain how the user interface works. If you need to
Do not explain common actions and entities. Show a regular tooltip with an action name and shortcut in this case.
| <format color="Red" style="bold">Incorrect</format> | <format color="Green" style="bold">Correct</format> |
|-----------------------------------------------------|-----------------------------------------------------|
| ![](07_explain_obvious_incorrect.png){width=300} | ![](07_explain_obvious_correct.png){width=145} |
<table>
<tr>
<td width="50%"><format color="Red" style="bold">Incorrect</format></td>
<td width="50%"><format color="Green" style="bold">Correct</format></td>
</tr>
<tr>
<td><img src="07_explain_obvious_incorrect.png" alt="" width="300" /></td>
<td><img src="07_explain_obvious_correct.png" alt="" width="145" /></td>
</tr>
</table>
Do not explain each option. Too many help icons or too much inline text make a dialog cluttered and harder to navigate visually.
If all options need to be explained, consider rewriting the labels to make them clearer.