Skip to content

Commit 5d0c235

Browse files
committed
Removed @see references to single data types in specs
Specs will from now on link to this documentation, not the other way around
1 parent c1d574e commit 5d0c235

File tree

1 file changed

+0
-12
lines changed

1 file changed

+0
-12
lines changed

src/index.ts

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,13 @@ declare namespace ServerState {
5656

5757
/**
5858
* We call numeric data containing 2D-points that can get plotted in a graph XYData. Below, you can find its specifications.
59-
*
60-
* @see https://server-state.github.io/specs/#/arch/data-formats?id=line-xy-data
6159
*/
6260
export type XYData = Array<XYDataPoint>;
6361

6462
/**
6563
* Hierarchical weighted data describes a tree structure, where nodes contain n child nodes and where all nodes have the size of the sum of the sum of all child nodes, with leaf nodes having an explicit size.
6664
*
6765
* Suggested visualizations: Lists, tables, treemaps, sunburst charts
68-
*
69-
* @see https://server-state.github.io/specs/#/arch/data-formats?id=hierarchical-weighted-data
7066
*/
7167
export type HierarchicalData = {
7268
/**
@@ -91,26 +87,20 @@ declare namespace ServerState {
9187
* Raw Markdown that gets generated in the SM and rendered in the client
9288
*
9389
* Suggested visualizations: Markdown renderer, Raw text renderer for environments with no Rich Text support
94-
*
95-
* @see https://server-state.github.io/specs/#/arch/data-formats?id=markdown
9690
*/
9791
export type Markdown = string;
9892

9993
/**
10094
* Raw text that gets generated in the SM and rendered in the client
10195
*
10296
* Suggested visualizations: Plain text output
103-
*
104-
* @see https://server-state.github.io/specs/#/arch/data-formats?id=text
10597
*/
10698
export type Text = string;
10799

108100
/**
109101
* Data that's "display-able" in a table format.
110102
*
111103
* Suggested visualizations: Table, Data Table, Selective charts (mapping numerical fields to x and y in line data)
112-
*
113-
* @see https://server-state.github.io/specs/#/arch/data-formats?id=tabletable-like
114104
*/
115105
export type TableData = {
116106
/**
@@ -131,8 +121,6 @@ declare namespace ServerState {
131121
* Please note that `true`/`false` should get mapped to _yes_/_no_ in visualizations.
132122
*
133123
* Suggested visualizations: Table, List
134-
*
135-
* @see https://server-state.github.io/specs/#/arch/data-formats?id=key-value-pair
136124
*/
137125
export type KeyValuePairData = { [key: string]: string | number | boolean };
138126
}

0 commit comments

Comments
 (0)