Skip to content

Commit 46d5873

Browse files
authored
Apply suggestion from @aaronsteers
1 parent 53eca65 commit 46d5873

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

bin/generate_component_manifest_files.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,14 @@ def generate_init_module_content() -> str:
3232

3333

3434
def generate_json_schema():
35-
"""Generate JSON schema from the YAML file for schemastore.org registration."""
35+
"""Generate JSON schema from the YAML file for schemastore.org registration.
36+
37+
When published to schemastore.org, a number of IDEs and libraries
38+
automatically apply the JSON Schema validation features such as:
39+
- auto-complete for keys and enums
40+
- hover-tooltips for descriptions and examples
41+
- linting squiggles for validation errors
42+
"""
3643
yaml_file_path = f"{LOCAL_YAML_DIR_PATH}/declarative_component_schema.yaml"
3744
json_file_path = f"{LOCAL_YAML_DIR_PATH}/generated/declarative_component_schema.json"
3845

0 commit comments

Comments
 (0)