Skip to content

Commit 90b35ce

Browse files
committed
more comment tweaks
1 parent 440db24 commit 90b35ce

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

site/src/theme/experimental.ts

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,13 @@ export interface NewTheme {
1111
l2: InteractiveRole; // sidebars, table headers, navigation
1212

1313
roles: {
14-
/** Deletion, immutable parameters, and things that have long lasting or irreversible effects */
15-
danger: InteractiveRole;
16-
17-
/** Something went wrong; either unexpectedly, or in a meaningful way */
14+
/** Something is wrong; either unexpectedly, or in a meaningful way. */
1815
error: Role;
1916

20-
/** Something isn't quite right, but without serious consequence */
17+
/** Something isn't quite right, but without serious consequence. */
2118
warning: Role;
2219

23-
/** A prompt for action, to correct or look into something */
20+
/** A prompt for action, to correct or look into something. */
2421
notice: Role;
2522

2623
/** Notable information; just so you know! */
@@ -29,10 +26,17 @@ export interface NewTheme {
2926
/** Confirmation, or affirming that things are as desired. */
3027
success: InteractiveRole;
3128

32-
/** Selected, in progress, of particular relevance right now */
29+
/** Selected, in progress, of particular relevance right now. */
3330
active: InteractiveRole;
3431

35-
/** This isn't quite ready for prime-time, but you're welcome to look around! preview features, experiments, unstable etc. */
32+
/** Actions that have long lasting or irreversible effects.
33+
* Deletion, immutable parameters, etc.
34+
*/
35+
danger: InteractiveRole;
36+
37+
/** This isn't quite ready for prime-time, but you're welcome to look around!
38+
* Preview features, experiments, unstable etc.
39+
*/
3640
preview: Role;
3741
};
3842
}
@@ -41,7 +45,7 @@ export interface NewTheme {
4145
* ie. I wish to communicate an error, I wish to communicate that this is dangerous, etc.
4246
*/
4347
export interface Role {
44-
/** A background color */
48+
/** A background color that works best with the corresponding `outline` and `text` colors */
4549
background: string;
4650

4751
/** A border, or a color for an outlined icon */

0 commit comments

Comments
 (0)