Closed techanvil closed 9 months ago
@marrrmarrr What is Site Kit's policy on punctuation for statements/sentences? It feels like all full sentences (barring a few exceptions as mentioned in the Issue description) within the plugin do not end with a full-stop, unless there are multiple sentences combined together where a full-stop is obviously needed. Should this be the case throughout our UI?
c.c. @aaemnnosttv @sigal-teller
@jimmymadon according to the style guide, single-sentence phrases like the ones in the screenshot above should have no full stop. If there is more than one sentence, then it's necessary to separate them with full stops.
Here is the full guidance for reference: "Skip periods and unnecessary punctuation
To help readers scan text, avoid using periods and other unnecessary punctuation.
Avoid using periods to end single sentences, particularly in: - Labels - Tooltip text - Bulleted lists - Dialog body text - Hyperlinked text
Use periods on: - Multiple sentences - Long or complex sentences, if it suits the context - Any sentence followed by a link"
AC :white_check_mark:
IB ✅
@kuasha420 Other than the first issue highlighted, I am not 100% sure about the others.
Would appreciate your opinion since these aren't multiple sentences.
@wpdarren Thank you for the detailed testing and observation. As mentioned by @bethanylang on Slack, the the periods removed from the lines with commas are fine. I've opened an additional PR to remove the other periods you've found. Cheers.
Back to you for another pass, @wpdarren.
@kuasha420 Just two observations, and I think we are done.
The AdSense 'ready' status screen needs the period removing.
Verified:
Feature Description
There is a bit of inconsistency with the way punctuation is applied in the plugin. For a specific example, see the Analytics settings view:
We should audit the plugin for any such inconsistencies, and fix them.
Do not alter or remove anything below. The following sections will be managed by moderators only.
Acceptance criteria
"Skip periods and unnecessary punctuation
To help readers scan text, avoid using periods and other unnecessary punctuation.
Avoid using periods to end single sentences, particularly in: - Labels - Tooltip text - Bulleted lists - Dialog body text - Hyperlinked text
Use periods on: - Multiple sentences - Long or complex sentences, if it suits the context - Any sentence followed by a link"
Implementation Brief
Tag Manager
settings, for code placement descriptionWe’re working on adding new services to Site Kit by Google all the time, so please check back in the future.
Test Coverage
QA Brief
Changelog entry