Skip to content

Commit 338be04

Browse files
authored
docs: Document that brand typography files takes a list (#12268)
The `files` field under brand typography now starts its description with "A list of font files to include." Users who pass a single string get `property name files is invalid` from the validator, and the hint in editor completion and hover now says the field takes a list. The item shapes stay in the schema and are not repeated in the text. - Update the `files` description in `src/resources/schema/definitions.yml`. - Regenerate the editor tooling and YAML intelligence resources so they ship the new text. Each generated file changes only the `files` description. Related to #12267. The validator error message itself is unchanged.
1 parent 5b23163 commit 338be04

6 files changed

Lines changed: 10 additions & 9 deletions

File tree

‎src/resources/editor/tools/vs-code.mjs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13336,7 +13336,7 @@ var require_yaml_intelligence_resources = __commonJS({
1333613336
}
1333713337
]
1333813338
},
13339-
description: "The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
13339+
description: "A list of font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
1334013340
}
1334113341
},
1334213342
required: [
@@ -23438,7 +23438,7 @@ var require_yaml_intelligence_resources = __commonJS({
2343823438
"The font display method, determines how a font face is font face is\nshown depending on its download status and readiness for use.",
2343923439
"A method for providing font files directly, either locally or from an\nonline location.",
2344023440
"The font family name.",
23441-
"The font files to include. These can be local or online. Local file\npaths should be relative to the <code>brand.yml</code> file. Online\npaths should be complete URLs.",
23441+
"A list of font files to include. These can be local or online. Local\nfile paths should be relative to the <code>brand.yml</code> file. Online\npaths should be complete URLs.",
2344223442
"The path to the font file. This can be a local path or a URL.",
2344323443
"A locally-installed font family name. When used, the end-user is\nresponsible for ensuring that the font is installed on their system.",
2344423444
"A path to a brand.yml file, or an object with light and dark paths to\nbrand.yml",

‎src/resources/editor/tools/yaml/all-schema-definitions.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎src/resources/editor/tools/yaml/web-worker.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/resources/editor/tools/yaml/yaml-intelligence-resources.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6304,7 +6304,7 @@
63046304
}
63056305
]
63066306
},
6307-
"description": "The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
6307+
"description": "A list of font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs.\n"
63086308
}
63096309
},
63106310
"required": [
@@ -16406,7 +16406,7 @@
1640616406
"The font display method, determines how a font face is font face is\nshown depending on its download status and readiness for use.",
1640716407
"A method for providing font files directly, either locally or from an\nonline location.",
1640816408
"The font family name.",
16409-
"The font files to include. These can be local or online. Local file\npaths should be relative to the <code>brand.yml</code> file. Online\npaths should be complete URLs.",
16409+
"A list of font files to include. These can be local or online. Local\nfile paths should be relative to the <code>brand.yml</code> file. Online\npaths should be complete URLs.",
1641016410
"The path to the font file. This can be a local path or a URL.",
1641116411
"A locally-installed font family name. When used, the end-user is\nresponsible for ensuring that the font is installed on their system.",
1641216412
"A path to a brand.yml file, or an object with light and dark paths to\nbrand.yml",

‎src/resources/schema/definitions.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3572,7 +3572,8 @@
35723572
# string:
35733573
# pattern: '^U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?(?:,U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?)*$'
35743574
description: >
3575-
The font files to include. These can be local or online.
3575+
A list of font files to include.
3576+
These can be local or online.
35763577
Local file paths should be relative to the `brand.yml` file.
35773578
Online paths should be complete URLs.
35783579
required: [files, family, source]

‎src/resources/types/schema-types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1729,7 +1729,7 @@ export type BrandFontFile = {
17291729
path: string;
17301730
style?: BrandFontStyle;
17311731
weight?: BrandFontWeight;
1732-
}))[] /* The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs. */;
1732+
}))[] /* A list of font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs. */;
17331733
source: "file";
17341734
}; /* A method for providing font files directly, either locally or from an online location. */
17351735

0 commit comments

Comments
 (0)