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

Changes from 1 commit
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))

##### typically styled as … by default

Use this phrase (or a closely similarly one like "typically styled in") to note unspecified but conventional browser default styling.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The default styling is actually specified in detail and quite interoperable. For <small>, it's here:

https://html.spec.whatwg.org/multipage/rendering.html#phrasing-content-3

I think I'd prefer us to say just "by default" for these cases.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh fascinating! That's worth amending over. Changes forthcoming

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.
> Typically styled in a reduced font size by default.

([#1379](https://github.com/web-platform-dx/web-features/pull/1379))

##### usage

Never use "usage" in the sense of "using."
Expand Down