Skip to content

Commit

Permalink
Add description guidelines for default styles (#1403)
Browse files Browse the repository at this point in the history
  • Loading branch information
ddbeck authored Jul 31, 2024
1 parent ee7fe79 commit 1605a8e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,17 @@ Avoid.
See [sets](#sets).
([#727](https://github.com/web-platform-dx/web-features/pull/727#discussion_r1537635491))

##### styling … as … by default

Use this phrase (or using another appropriate preposition, such as "styling in") to note conventional or standardized default styling.
The ellipses stand in for the thing being styled (e.g., "text") and the style itself (e.g., "italic").
Use it before [_also known as_ text](#also-known-as).
For example:

> The `<small>` element represents side-comments and small print, like copyright and legal text, styling text in a reduced font size by default.
([#1403](https://github.com/web-platform-dx/web-features/pull/1403), [#1379](https://github.com/web-platform-dx/web-features/pull/1379))

##### usage

Never use "usage" in the sense of "using."
Expand Down
2 changes: 1 addition & 1 deletion features/samp.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: <samp>
description: The `<samp>` element represents an in-line sample (or quoted) output from a computer program. Typically styled as monospaced type by default.
description: The `<small>` element represents side-comments and small print, like copyright and legal text, styling text in a reduced font size by default.
spec: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-samp-element
group: html-elements
compat_features:
Expand Down
2 changes: 1 addition & 1 deletion features/small.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: <small>
description: The `<small>` element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. Typically styled in a reduced font size by default.
description: The `<small>` element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. Styled in a reduced font size by default.
spec: https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-small-element
group: html-elements
compat_features:
Expand Down

0 comments on commit 1605a8e

Please sign in to comment.