Use single-line syntax for private types comments #8420
Conversation
This prevents the comments from appearing in editors
| // Use the `media` query strategy. | ||
| | 'media' | ||
| /** Use the `class` stategy, which requires a `.dark` class on the `html`. */ | ||
| // Use the `class` stategy, which requires a `.dark` class on the `html`. | ||
| | 'class' | ||
| /** Use the `class` stategy with a custom class instead of `.dark`. */ | ||
| // Use the `class` stategy with a custom class instead of `.dark`. |
There was a problem hiding this comment.
I think that for these it could still be useful to know what each type means. But maybe they don't show up at all
| @@ -242,15 +242,15 @@ type ValueType = | |||
| | 'relative-size' | |||
| | 'shadow' | |||
| export interface PluginAPI { | |||
| /** for registering new static utility styles */ | |||
| // for registering new static utility styles | |||
There was a problem hiding this comment.
These could also be useful to the user, or do you reckon that this is a bit redundant because the name addUtilities itself is self explanatory enough?
There was a problem hiding this comment.
I agree that we could write some documentation comments that are useful to users, but it seems like the comments in this file right now have not been written for that purpose, and it was not the intention for these to be visible to users. Consider comments like Utilities or Responsiveness for example. I propose that we hide everything for now and consider adding proper documentation comments in the future.
There was a problem hiding this comment.
Yep sounds good, let's merge it
This prevents the comments from appearing in a user's editor.
Before
After