Skip to content

Commit c449ef0

Browse files
committed
updating doc contents
1 parent 92c5fa9 commit c449ef0

36 files changed

+3887
-3215
lines changed

docs/data/documentation/swiftviz.json

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,36 @@
324324
},
325325
"doc://com.github.swiftviz.SwiftViz/documentation/SwiftViz/Scale": {
326326
"abstract" : [
327-
327+
{
328+
"text" : "A scale maps values from an input ",
329+
"type" : "text"
330+
},
331+
{
332+
"inlineContent" : [
333+
{
334+
"text" : "domain",
335+
"type" : "text"
336+
}
337+
],
338+
"type" : "emphasis"
339+
},
340+
{
341+
"text" : " to an output ",
342+
"type" : "text"
343+
},
344+
{
345+
"inlineContent" : [
346+
{
347+
"text" : "range",
348+
"type" : "text"
349+
}
350+
],
351+
"type" : "emphasis"
352+
},
353+
{
354+
"text" : ".",
355+
"type" : "text"
356+
}
328357
],
329358
"fragments" : [
330359
{
@@ -358,30 +387,6 @@
358387
{
359388
"text" : "A Tick is a visual representation of a point along an axis.",
360389
"type" : "text"
361-
},
362-
{
363-
"text" : " ",
364-
"type" : "text"
365-
},
366-
{
367-
"text" : "When created based on a range, it includes a location along a single direction",
368-
"type" : "text"
369-
},
370-
{
371-
"text" : " ",
372-
"type" : "text"
373-
},
374-
{
375-
"text" : "and a textual representation. It is meant to be created using a Scale, with some input domain",
376-
"type" : "text"
377-
},
378-
{
379-
"text" : " ",
380-
"type" : "text"
381-
},
382-
{
383-
"text" : "being mapped to visualization using the Scale’s output range.",
384-
"type" : "text"
385390
}
386391
],
387392
"fragments" : [

docs/data/documentation/swiftviz/cgfloattick.json

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -493,30 +493,6 @@
493493
{
494494
"text" : "A Tick is a visual representation of a point along an axis.",
495495
"type" : "text"
496-
},
497-
{
498-
"text" : " ",
499-
"type" : "text"
500-
},
501-
{
502-
"text" : "When created based on a range, it includes a location along a single direction",
503-
"type" : "text"
504-
},
505-
{
506-
"text" : " ",
507-
"type" : "text"
508-
},
509-
{
510-
"text" : "and a textual representation. It is meant to be created using a Scale, with some input domain",
511-
"type" : "text"
512-
},
513-
{
514-
"text" : " ",
515-
"type" : "text"
516-
},
517-
{
518-
"text" : "being mapped to visualization using the Scale’s output range.",
519-
"type" : "text"
520496
}
521497
],
522498
"fragments" : [

docs/data/documentation/swiftviz/datetick.json

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -458,30 +458,6 @@
458458
{
459459
"text" : "A Tick is a visual representation of a point along an axis.",
460460
"type" : "text"
461-
},
462-
{
463-
"text" : " ",
464-
"type" : "text"
465-
},
466-
{
467-
"text" : "When created based on a range, it includes a location along a single direction",
468-
"type" : "text"
469-
},
470-
{
471-
"text" : " ",
472-
"type" : "text"
473-
},
474-
{
475-
"text" : "and a textual representation. It is meant to be created using a Scale, with some input domain",
476-
"type" : "text"
477-
},
478-
{
479-
"text" : " ",
480-
"type" : "text"
481-
},
482-
{
483-
"text" : "being mapped to visualization using the Scale’s output range.",
484-
"type" : "text"
485461
}
486462
],
487463
"fragments" : [

docs/data/documentation/swiftviz/doubletick.json

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -493,30 +493,6 @@
493493
{
494494
"text" : "A Tick is a visual representation of a point along an axis.",
495495
"type" : "text"
496-
},
497-
{
498-
"text" : " ",
499-
"type" : "text"
500-
},
501-
{
502-
"text" : "When created based on a range, it includes a location along a single direction",
503-
"type" : "text"
504-
},
505-
{
506-
"text" : " ",
507-
"type" : "text"
508-
},
509-
{
510-
"text" : "and a textual representation. It is meant to be created using a Scale, with some input domain",
511-
"type" : "text"
512-
},
513-
{
514-
"text" : " ",
515-
"type" : "text"
516-
},
517-
{
518-
"text" : "being mapped to visualization using the Scale’s output range.",
519-
"type" : "text"
520496
}
521497
],
522498
"fragments" : [

docs/data/documentation/swiftviz/integertick.json

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -493,30 +493,6 @@
493493
{
494494
"text" : "A Tick is a visual representation of a point along an axis.",
495495
"type" : "text"
496-
},
497-
{
498-
"text" : " ",
499-
"type" : "text"
500-
},
501-
{
502-
"text" : "When created based on a range, it includes a location along a single direction",
503-
"type" : "text"
504-
},
505-
{
506-
"text" : " ",
507-
"type" : "text"
508-
},
509-
{
510-
"text" : "and a textual representation. It is meant to be created using a Scale, with some input domain",
511-
"type" : "text"
512-
},
513-
{
514-
"text" : " ",
515-
"type" : "text"
516-
},
517-
{
518-
"text" : "being mapped to visualization using the Scale’s output range.",
519-
"type" : "text"
520496
}
521497
],
522498
"fragments" : [

docs/data/documentation/swiftviz/linearscale.json

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,10 @@
297297
},
298298
"doc://com.github.swiftviz.SwiftViz/documentation/SwiftViz/LinearScale/domain": {
299299
"abstract" : [
300-
300+
{
301+
"text" : "The range of input values",
302+
"type" : "text"
303+
}
301304
],
302305
"fragments" : [
303306
{
@@ -480,7 +483,10 @@
480483
},
481484
"doc://com.github.swiftviz.SwiftViz/documentation/SwiftViz/LinearScale/isClamped": {
482485
"abstract" : [
483-
486+
{
487+
"text" : "A boolean value that indicates whether the output vales are constrained to the min and max of the output range.",
488+
"type" : "text"
489+
}
484490
],
485491
"fragments" : [
486492
{
@@ -720,7 +726,36 @@
720726
},
721727
"doc://com.github.swiftviz.SwiftViz/documentation/SwiftViz/Scale": {
722728
"abstract" : [
723-
729+
{
730+
"text" : "A scale maps values from an input ",
731+
"type" : "text"
732+
},
733+
{
734+
"inlineContent" : [
735+
{
736+
"text" : "domain",
737+
"type" : "text"
738+
}
739+
],
740+
"type" : "emphasis"
741+
},
742+
{
743+
"text" : " to an output ",
744+
"type" : "text"
745+
},
746+
{
747+
"inlineContent" : [
748+
{
749+
"text" : "range",
750+
"type" : "text"
751+
}
752+
],
753+
"type" : "emphasis"
754+
},
755+
{
756+
"text" : ".",
757+
"type" : "text"
758+
}
724759
],
725760
"fragments" : [
726761
{

docs/data/documentation/swiftviz/linearscale/domain.json

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
11
{
22
"abstract" : [
33
{
4-
"text" : "Inherited from ",
5-
"type" : "text"
6-
},
7-
{
8-
"code" : "Scale.domain",
9-
"type" : "codeVoice"
10-
},
11-
{
12-
"text" : ".",
4+
"text" : "The range of input values",
135
"type" : "text"
146
}
157
],
@@ -205,7 +197,10 @@
205197
},
206198
"doc://com.github.swiftviz.SwiftViz/documentation/SwiftViz/LinearScale/domain": {
207199
"abstract" : [
208-
200+
{
201+
"text" : "The range of input values",
202+
"type" : "text"
203+
}
209204
],
210205
"fragments" : [
211206
{

docs/data/documentation/swiftviz/linearscale/isclamped.json

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
11
{
22
"abstract" : [
33
{
4-
"text" : "Inherited from ",
5-
"type" : "text"
6-
},
7-
{
8-
"code" : "Scale.isClamped",
9-
"type" : "codeVoice"
10-
},
11-
{
12-
"text" : ".",
4+
"text" : "A boolean value that indicates whether the output vales are constrained to the min and max of the output range.",
135
"type" : "text"
146
}
157
],
@@ -97,6 +89,42 @@
9789
}
9890
],
9991
"kind" : "declarations"
92+
},
93+
{
94+
"content" : [
95+
{
96+
"anchor" : "discussion",
97+
"level" : 2,
98+
"text" : "Discussion",
99+
"type" : "heading"
100+
},
101+
{
102+
"inlineContent" : [
103+
{
104+
"text" : "If ",
105+
"type" : "text"
106+
},
107+
{
108+
"code" : "true",
109+
"type" : "codeVoice"
110+
},
111+
{
112+
"text" : ", values processed by the scale are constrained to the output range, and values processed backwards through the scale",
113+
"type" : "text"
114+
},
115+
{
116+
"text" : " ",
117+
"type" : "text"
118+
},
119+
{
120+
"text" : "are constrained to the input domain.",
121+
"type" : "text"
122+
}
123+
],
124+
"type" : "paragraph"
125+
}
126+
],
127+
"kind" : "content"
100128
}
101129
],
102130
"schemaVersion" : {
@@ -179,7 +207,10 @@
179207
},
180208
"doc://com.github.swiftviz.SwiftViz/documentation/SwiftViz/LinearScale/isClamped": {
181209
"abstract" : [
182-
210+
{
211+
"text" : "A boolean value that indicates whether the output vales are constrained to the min and max of the output range.",
212+
"type" : "text"
213+
}
183214
],
184215
"fragments" : [
185216
{

0 commit comments

Comments
 (0)