Fix erroneous examples in document for Table Groups

holistics · Aug 27, 2024 · 7010fcc · 7010fcc
1 parent 316fd7c
commit 7010fcc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/dbml-homepage/docs/docs.md b/dbml-homepage/docs/docs.md
@@ -435,7 +435,7 @@ Table orders {
 ### TableGroup Notes
 
 ```text
-TableGroup e-commerce [note: 'Contains tables that are related to e-commerce system'] {
+TableGroup e_commerce [note: 'Contains tables that are related to e-commerce system'] {
   merchants
   countries
 
@@ -479,7 +479,7 @@ TableGroup tablegroup_name { // tablegroup is case-insensitive.
 }
 
 // example
-TableGroup e-commerce1 {
+TableGroup e_commerce1 {
   merchants
   countries
 }
@@ -490,7 +490,7 @@ TableGroup e-commerce1 {
 Table groupings can be annotated with notes that describe their meaning and purpose.
 
 ```text
-TableGroup e-commerce [note: 'Contains tables that are related to e-commerce system'] {
+TableGroup e_commerce [note: 'Contains tables that are related to e-commerce system'] {
   merchants
   countries
 
@@ -509,7 +509,7 @@ The list of table group settings you can use:
 
 Example,
 ```text
-TableGroup e-commerce [color: #345] {
+TableGroup e_commerce [color: #345] {
   merchants
   countries
 }

diff --git a/packages/dbml-core/types/model_structure/tableGroup.d.ts b/packages/dbml-core/types/model_structure/tableGroup.d.ts
@@ -21,6 +21,7 @@ declare class TableGroup extends Element {
     id: number;
     note: string;
     noteToken: Token;
+    color: string;
     constructor({ name, token, tables, schema, note, color }: RawTableGroup);
     generateId(): void;
     processTables(rawTables: any): void;