Closed Bug 1691223 Opened 3 years ago Closed 3 years ago

Updating schema files for theme API

Categories

(Thunderbird :: Theme, enhancement)

enhancement

Tracking

(thunderbird_esr78? fixed, thunderbird87 fixed)

RESOLVED FIXED
87 Branch
Tracking Status
thunderbird_esr78 ? fixed
thunderbird87 --- fixed

People

(Reporter: TbSync, Assigned: TbSync)

Details

Attachments

(2 files, 2 obsolete files)

+++ This bug was initially created as a clone of Bug #1684666 +++

After working on the API documentation for the new theme API, I found a few missing descriptions.

Only simple description changes. Includes a few changes from other APIs which did not bother me enough to create a bug yet.

Attachment #9201621 - Flags: review?(richard.marti)
Attachment #9201627 - Flags: review?(richard.marti)

Comment on attachment 9201627 [details] [diff] [review]
bug1691223_fix_schema_descriptions.patch

Only simple description changes.

Comment on attachment 9201621 [details] [diff] [review]
bug1691223_fix_schema_descriptions_ESR78.patch

Review of attachment 9201621 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks

::: mail/components/extensions/schemas/theme.json
@@ +21,4 @@
>          "choices": [
>            {
> +            "type": "string",
> +            "description": "A string containing a valid `CSS color string <https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords>`__ or a hexadecimal representation. For example ``crimson`` or  ``#dc143c``."

Maybe you should also add rgb(a) and hsl(a) examples here.
Attachment #9201621 - Flags: review?(richard.marti) → review+
Comment on attachment 9201627 [details] [diff] [review]
bug1691223_fix_schema_descriptions.patch

Review of attachment 9201627 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks.

::: mail/components/extensions/schemas/theme.json
@@ +21,4 @@
>          "choices": [
>            {
> +            "type": "string",
> +            "description": "A string containing a valid `CSS color string <https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords>`__ or a hexadecimal representation. For example ``crimson`` or  ``#dc143c``."

Maybe you should also add rgb(a) and hsl(a) examples here.
Attachment #9201627 - Flags: review?(richard.marti) → review+

Maybe you should also add rgb(a) and hsl(a) examples here.

Good catch, I did not know this works:

  "theme": {
    "colors": {
      "exp_chat_button": "rgba(0,255,0,0.3)"
    }
  }

So I will update the description to be

"A string containing a valid CSS color string <https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#color_keywords>__, including hexadecimal or functional representation." And extend the examples. Would that be ok?

Sounds good.

Also update a few color definitions.

Attachment #9201621 - Attachment is obsolete: true
Attachment #9201764 - Flags: review?(richard.marti)

Also update a few color definitions.

You can see the rendered page and the added examples for rgba() and friends here:
https://webextension-api.thunderbird.net/en/78/theme.html#themecolor

Attachment #9201627 - Attachment is obsolete: true
Attachment #9201765 - Flags: review?(richard.marti)
Attachment #9201764 - Flags: review?(richard.marti) → review+
Attachment #9201765 - Flags: review?(richard.marti) → review+

Pushed by geoff@darktrojan.net:
https://hg.mozilla.org/comm-central/rev/4f18ae7edfff
Update descriptions of theme API and others. r=Paenglab

Status: ASSIGNED → RESOLVED
Closed: 3 years ago
Resolution: --- → FIXED
Target Milestone: --- → 87 Branch

Comment on attachment 9201764 [details] [diff] [review]
bug1691223_fix_schema_descriptions_ESR78_v2.patch

[Approval Request Comment]
Regression caused by (bug #):
User impact if declined:
Testing completed (on c-c, etc.):
Risk to taking this patch (and alternatives if risky):
None, Description changes relevant for the API documentation only.

Attachment #9201764 - Flags: approval-comm-esr78?

Comment on attachment 9201764 [details] [diff] [review]
bug1691223_fix_schema_descriptions_ESR78_v2.patch

[Triage Comment]
Approved for esr78

Attachment #9201764 - Flags: approval-comm-esr78? → approval-comm-esr78+
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: