Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description guidelines for default styles #1403

Merged
merged 6 commits into from
Jul 31, 2024
Merged

Add description guidelines for default styles #1403

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aba670a
Add description guidelines for default styles
ddbeck Jul 16, 2024
0c52db9
Merge branch 'main' into typically-styled
ddbeck Jul 22, 2024
2b04f73
Revise to capture standardized styling practices too
ddbeck Jul 22, 2024
5a79412
Apply new recommendation
ddbeck Jul 22, 2024
26a8cf7
Merge branch 'main' into typically-styled
ddbeck Jul 23, 2024
8e41e30
Revise convention
ddbeck Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/README.md
View file
Open in desktop
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))

##### styled as … by default
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In #1368 I've made suggestions on the form "... rendering text as bold by default". @ddbeck I don't have a strong preference, but can you align this guideline with what you'd like to see in that PR?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've suggested a small change of your approach and updated this PR to reflect it. I will monitor for additional feedback. 😄


Use this phrase (or using another appropriate preposition, such as "styled in") to note conventional or standardized default styling.
Use it at the end of the description, but before [_also known as_ text](#also-known-as).
For example:

> 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.

([#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
View file
Open in desktop
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 `<samp>` element represents an in-line sample (or quoted) output from a computer program. Styled as monospaced type 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
View file
Open in desktop
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