Bug 231566 – Update CSSDocumentation.js with latest upstream data to fix wrong documentation for block-size

• Component: Web Inspector
• Status: RESOLVED FIXED

[Paul Li]

Created attachment 440910 [details]
inspect element & check its documentation

Steps to reproduce the problem:
1. Turn on devTool & inspect element to check its CSS property.
2. Focus on "block-size" property and click the hint to see its documentation.
3. The hint indicates block-size is Logical 'width'.

What is the expected behavior?
The hint should indicates block-size is Logical 'height'.

What went wrong?
The hint should indicates block-size is Logical 'width'.

[Radar WebKit Bug Importer]

<rdar://problem/84406443>

[Razvan Caliman]

This has been fixed upstream in https://github.com/microsoft/vscode-custom-data/issues/27

We need to pull the latest and update: 
Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js

[Razvan Caliman]

Created attachment 442698 [details]
[fast-cq] Patch 1.0

Run script added in Bug 232433 to update CSSDocumentation.js with latest upstream data which contains fixes for the descriptions of logical properties for sizing

[Patrick Angle]

Comment on attachment 442698 [details]
[fast-cq] Patch 1.0

View in context: https://bugs.webkit.org/attachment.cgi?id=442698&action=review

> Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js:140
> +        "description": "Processes an elementâs rendering before it is displayed in the document, by applying one or more filter effects."

There seem to be encoding issues throughout where the data shouldn't have changed, but ends up re/mis-encoded with the new script. I've also left a comment on the generator script patch.

> Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js:2616
> -};
> +}

Another generator issue/NIT is that we should keep the trailing semicolon.

[Devin Rousso]

Comment on attachment 442698 [details]
[fast-cq] Patch 1.0

View in context: https://bugs.webkit.org/attachment.cgi?id=442698&action=review

>> Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js:140
>> +        "description": "Processes an elementâs rendering before it is displayed in the document, by applying one or more filter effects."
> 
> There seem to be encoding issues throughout where the data shouldn't have changed, but ends up re/mis-encoded with the new script. I've also left a comment on the generator script patch.

yeah in general please keep all JS/CSS files to be UTF-8 encoded as that's more efficient for parsing (and it's nicer in bugzilla review tool as well)

> Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js:304
> +    "accent-color": {

It's odd for a bug that specifically calls out `block-size` to have changes for other unrelated properties.  Perhaps this bug should be renamed to something more generic and have `block-size` just be an example of the motivation for the change?

[Razvan Caliman]

Per comment #5:

Retitled as:
"Update CSSDocumentation.js with latest upstream data to fix wrong documentation for block-size"

Was:
"Inline CSS documentation wrong for block-size"

[Razvan Caliman]

Created attachment 443243 [details]
Patch 1.1

Run script added in Bug 232433 to update CSSDocumentation.js. Addressed code review feedback

[Patrick Angle]

Comment on attachment 443243 [details]
Patch 1.1

View in context: https://bugs.webkit.org/attachment.cgi?id=443243&action=review

> Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js:2617
> -};
> +};

Style: Missing newline at end of file (probably need fixed in the script). Otherwise LGTM.

[Razvan Caliman]

Created attachment 443403 [details]
[fast-cq] Patch 1.2

Add newline at the end

[Devin Rousso]

Comment on attachment 443403 [details]
[fast-cq] Patch 1.2

View in context: https://bugs.webkit.org/attachment.cgi?id=443403&action=review

r=me

> Source/WebInspectorUI/ChangeLog:3
> +        Inline CSS documentation wrong for block-size

this should be updated to match the new bug title

> Source/WebInspectorUI/UserInterface/External/CSSDocumentation/CSSDocumentation.js:1
> +// This file is generated by update-css-documentation. Do not edit.

NIT: Id suggest putting the full path from the root of the WebKit source tree so that it's explicitly clear what you're referring to
```
    // DO NOT EDIT THIS FILE. It is automatically generated by the script: Source/WebInspectorUI/Scripts/update-css-documentation.py
```

[Razvan Caliman]

Created attachment 443552 [details]
[fast-cq] Patch 1.3

Carry over R+. Regenerate file with the latest version of the script from Bug 232433. Fix Changelog

[EWS]

Committed r285405 (243962@main): <https://commits.webkit.org/243962@main>

All reviewed patches have been landed. Closing bug and clearing flags on attachment 443552 [details].