From a79ab3297ad00b9fcb85b06022a317b61a8e6bde Mon Sep 17 00:00:00 2001 From: James Stuckey Weber Date: Wed, 2 Oct 2024 11:54:45 -0400 Subject: [PATCH 1/3] Shorthand and longhand styleguide --- docs/guidelines.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/guidelines.md b/docs/guidelines.md index af9b7864716..50a83af73b1 100644 --- a/docs/guidelines.md +++ b/docs/guidelines.md @@ -195,6 +195,13 @@ Omit "is used" where there's no loss in meaning. For example, prefer "The feature reads…" over "The feature is used to read…" ([#727](https://github.com/web-platform-dx/web-features/pull/727#discussion_r1537635981)) +#### longhands and shorthands + +In CSS, use the terms "shorthand" and "longhand" to describe the relationship +between CSS properties that combine multiple properties into a single +declaration and the individual properties. +([#1764](https://github.com/web-platform-dx/web-features/pull/1764#discussion_r1777335770)) + #### platform "platform" is often vague. From 0bb48e7caa6b1b7c6d552744f9dc349e43105ee4 Mon Sep 17 00:00:00 2001 From: James Stuckey Weber Date: Mon, 7 Oct 2024 13:43:24 -0400 Subject: [PATCH 2/3] Clarify property --- docs/guidelines.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/guidelines.md b/docs/guidelines.md index 50a83af73b1..0d9942e1801 100644 --- a/docs/guidelines.md +++ b/docs/guidelines.md @@ -197,9 +197,11 @@ For example, prefer "The feature reads…" over "The feature is used to read…" #### longhands and shorthands -In CSS, use the terms "shorthand" and "longhand" to describe the relationship -between CSS properties that combine multiple properties into a single -declaration and the individual properties. +Prefer the terms "shorthand" and "longhand" to describe the relationship between CSS properties that combine multiple properties into a single declaration and the individual properties. + +Avoid using these terms without the word "property", so prefer "The `text-wrap` CSS property is a shorthand" over "The `text-wrap` CSS shorthand", and "It is a longhand property of..." over "It is a longhand of". + +Avoid the phrase "constituent properties" for longhand properties, even though this is common on MDN Web Docs. ([#1764](https://github.com/web-platform-dx/web-features/pull/1764#discussion_r1777335770)) #### platform From 3049153b381d65e048d867ac73bea205260ae62e Mon Sep 17 00:00:00 2001 From: James Stuckey Weber Date: Mon, 14 Oct 2024 09:24:05 -0400 Subject: [PATCH 3/3] Review --- docs/guidelines.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/guidelines.md b/docs/guidelines.md index 0d9942e1801..263bb2fe97b 100644 --- a/docs/guidelines.md +++ b/docs/guidelines.md @@ -197,9 +197,12 @@ For example, prefer "The feature reads…" over "The feature is used to read…" #### longhands and shorthands -Prefer the terms "shorthand" and "longhand" to describe the relationship between CSS properties that combine multiple properties into a single declaration and the individual properties. +Use the terms "shorthand" and "longhand" to describe the relationship between CSS properties that combine multiple properties into a single declaration and the individual properties. -Avoid using these terms without the word "property", so prefer "The `text-wrap` CSS property is a shorthand" over "The `text-wrap` CSS shorthand", and "It is a longhand property of..." over "It is a longhand of". +Avoid using "shorthand" and "longhand" without the word "property": + +* Prefer "The `text-wrap` CSS property is a shorthand" over "The `text-wrap` CSS shorthand". +* Prefer "It is a longhand property of" over "It is a longhand of". Avoid the phrase "constituent properties" for longhand properties, even though this is common on MDN Web Docs. ([#1764](https://github.com/web-platform-dx/web-features/pull/1764#discussion_r1777335770))