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.

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

core(cls): shorten description #10570

Merged
merged 10 commits into from
Apr 28, 2020
Merged

core(cls): shorten description #10570

merged 10 commits into from
Apr 28, 2020

Conversation

connorjclark
Copy link
Collaborator

image

It's a bit long ...

I shortened it without removing any information - simplified the grammar constructs (being a ... is a longer way to say is).

Further ideas for simplification / changes:

A layout shift is any movement an element makes once it is visible
->
A layout shift is when an element moves.
Layout shifts are recorded, scored, and then aggregated into a cumulative score between 0 and 1; 0 is a stable page, and >=0.5 is a highly shifting page
->
Layout shifts are aggregated into a score between 0 and 1; 0 is a stable page, and >=0.5 is a highly shifting page

0.5 seems like a high range. even 0.33 looks "highly shifting"

image

"between 0 and 1" is not true. CLS can be >1.

@connorjclark connorjclark requested a review from a team as a code owner April 10, 2020 21:43
@connorjclark connorjclark requested review from brendankenny and removed request for a team April 10, 2020 21:43
@vercel vercel bot temporarily deployed to Preview April 10, 2020 21:45 Inactive
@paulirish
Copy link
Member

i think we can drop the scoring bit. the learnmore link covers that.

here's my attempt at a really terse explanation:

Cumulative Layout Shift measures the amount of layout changes of visible elements within the viewport, scaled by element size and movement distance.

@connorjclark
Copy link
Collaborator Author

Cumulative Layout Shift measures the amount of layout changes of visible elements

i raise you this

@brendankenny
Copy link
Member

I'll cede this one to @paulirish

@brendankenny brendankenny requested review from paulirish and removed request for brendankenny April 15, 2020 20:07
@paulirish
Copy link
Member

Cumulative Layout Shift measures the amount of layout changes of visible elements

i raise you this

works for me.

@connorjclark
Copy link
Collaborator Author

wording was a little awkward and I didn't like reusing 'layout'

Cumulative Layout Shift measures how much visible elements move around the page

@brendankenny
Copy link
Member

wording was a little awkward and I didn't like reusing 'layout'

Cumulative Layout Shift measures how much visible elements move around the page

Now i'm not so sure about this :)

"how much" causes a miscue for me while reading, where I think the thing immediately after it is what's being measured, then it reads like a grammar error ("how much visible elements?") and then I realize "move" is what is being measured, but by then I've lost the flow.

If we want to keep this general form, something like

Cumulative Layout Shift measures the movement of visible elements around the page.

(or within the viewport, etc) could also work.

@paulirish
Copy link
Member

sure.

i like:

Cumulative Layout Shift measures the movement of visible elements within the viewport.

@vercel vercel bot temporarily deployed to Preview April 27, 2020 23:19 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants