Dataform allows you to add documentation to the datasets defined in your project.
Table and field descriptions are added using the config block.
1config { 2 type: "table", 3 description: "This table defines something", 4 columns: { 5 column1: "A test column", 6 column2: "A test column", 7 record1: { 8 description: "A struct", 9 columns: { 10 column3: "A nested column" 11 } 12 } 13 } 14}
Alternatively you can use the JavaScript API:
1publish("table1", { 2 type: "table", 3 description: "This table defines something", 4 columns: { 5 column1: "A test column", 6 column2: "A test column", 7 record1: { 8 description: "A struct", 9 columns: { 10 column3: "A nested column", 11 }, 12 }, 13 }, 14});