Skip to content

Commit 4bbb669

Browse files
my-tienmy-tien
committed
Adjust attribute descriptions with property formatting and mention of -0.5 and 0.5 for category start/end
1 parent 91db7c8 commit 4bbb669

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

‎src/components/selections/attributes.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ module.exports = overrideAll(templatedArray('selection', {
6161
max: 1,
6262
editType: 'calc',
6363
description: [
64-
'Only relevant if xref is a (multi-)category axes. Shifts x0 by a fraction of the',
65-
'reference unit.'
64+
'Only relevant if `xref` is a (multi-)category axes. Shifts `x0` by a fraction of the',
65+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
6666
].join(' ')
6767
},
6868
x1shift: {
@@ -72,8 +72,8 @@ module.exports = overrideAll(templatedArray('selection', {
7272
max: 1,
7373
editType: 'calc',
7474
description: [
75-
'Only relevant if xref is a (multi-)category axes. Shifts x1 by a fraction of the',
76-
'reference unit.'
75+
'Only relevant if `xref` is a (multi-)category axes. Shifts `x1` by a fraction of the',
76+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
7777
].join(' ')
7878
},
7979
y0shift: {
@@ -83,8 +83,8 @@ module.exports = overrideAll(templatedArray('selection', {
8383
max: 1,
8484
editType: 'calc',
8585
description: [
86-
'Only relevant if yref is a (multi-)category axes. Shifts y0 by a fraction of the',
87-
'reference unit.'
86+
'Only relevant if `yref` is a (multi-)category axes. Shifts `y0` by a fraction of the',
87+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
8888
].join(' ')
8989
},
9090
y1shift: {
@@ -94,8 +94,8 @@ module.exports = overrideAll(templatedArray('selection', {
9494
max: 1,
9595
editType: 'calc',
9696
description: [
97-
'Only relevant if yref is a (multi-)category axes. Shifts y1 by a fraction of the',
98-
'reference unit.'
97+
'Only relevant if `yref` is a (multi-)category axes. Shifts `y1` by a fraction of the',
98+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
9999
].join(' ')
100100
},
101101

‎src/components/shapes/attributes.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,8 @@ module.exports = templatedArray('shape', {
176176
max: 1,
177177
editType: 'calc',
178178
description: [
179-
'Only relevant if xref is a (multi-)category axes. Shifts x0 by a fraction of the',
180-
'reference unit.'
179+
'Only relevant if `xref` is a (multi-)category axes. Shifts `x0` by a fraction of the',
180+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
181181
].join(' ')
182182
},
183183
x1shift: {
@@ -187,8 +187,8 @@ module.exports = templatedArray('shape', {
187187
max: 1,
188188
editType: 'calc',
189189
description: [
190-
'Only relevant if xref is a (multi-)category axes. Shifts x1 by a fraction of the',
191-
'reference unit.'
190+
'Only relevant if `xref` is a (multi-)category axes. Shifts `x1` by a fraction of the',
191+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
192192
].join(' ')
193193
},
194194
yref: extendFlat({}, annAttrs.yref, {
@@ -248,8 +248,8 @@ module.exports = templatedArray('shape', {
248248
max: 1,
249249
editType: 'calc',
250250
description: [
251-
'Only relevant if yref is a (multi-)category axes. Shifts y0 by a fraction of the',
252-
'reference unit.'
251+
'Only relevant if `yref` is a (multi-)category axes. Shifts `y0` by a fraction of the',
252+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
253253
].join(' ')
254254
},
255255
y1shift: {
@@ -259,8 +259,8 @@ module.exports = templatedArray('shape', {
259259
max: 1,
260260
editType: 'calc',
261261
description: [
262-
'Only relevant if yref is a (multi-)category axes. Shifts y1 by a fraction of the',
263-
'reference unit.'
262+
'Only relevant if `yref` is a (multi-)category axes. Shifts `y1` by a fraction of the',
263+
'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
264264
].join(' ')
265265
},
266266
path: {

‎test/plot-schema.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9556,7 +9556,7 @@
95569556
"valType": "any"
95579557
},
95589558
"x0shift": {
9559-
"description": "Only relevant if xref is a (multi-)category axes. Shifts x0 by a fraction of the reference unit.",
9559+
"description": "Only relevant if `xref` is a (multi-)category axes. Shifts `x0` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
95609560
"dflt": 0,
95619561
"editType": "arraydraw",
95629562
"max": 1,
@@ -9569,7 +9569,7 @@
95699569
"valType": "any"
95709570
},
95719571
"x1shift": {
9572-
"description": "Only relevant if xref is a (multi-)category axes. Shifts x1 by a fraction of the reference unit.",
9572+
"description": "Only relevant if `xref` is a (multi-)category axes. Shifts `x1` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
95739573
"dflt": 0,
95749574
"editType": "arraydraw",
95759575
"max": 1,
@@ -9591,7 +9591,7 @@
95919591
"valType": "any"
95929592
},
95939593
"y0shift": {
9594-
"description": "Only relevant if yref is a (multi-)category axes. Shifts y0 by a fraction of the reference unit.",
9594+
"description": "Only relevant if `yref` is a (multi-)category axes. Shifts `y0` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
95959595
"dflt": 0,
95969596
"editType": "arraydraw",
95979597
"max": 1,
@@ -9604,7 +9604,7 @@
96049604
"valType": "any"
96059605
},
96069606
"y1shift": {
9607-
"description": "Only relevant if yref is a (multi-)category axes. Shifts y1 by a fraction of the reference unit.",
9607+
"description": "Only relevant if `yref` is a (multi-)category axes. Shifts `y1` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
96089608
"dflt": 0,
96099609
"editType": "arraydraw",
96109610
"max": 1,
@@ -10038,7 +10038,7 @@
1003810038
"valType": "any"
1003910039
},
1004010040
"x0shift": {
10041-
"description": "Only relevant if xref is a (multi-)category axes. Shifts x0 by a fraction of the reference unit.",
10041+
"description": "Only relevant if `xref` is a (multi-)category axes. Shifts `x0` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
1004210042
"dflt": 0,
1004310043
"editType": "calc",
1004410044
"max": 1,
@@ -10051,7 +10051,7 @@
1005110051
"valType": "any"
1005210052
},
1005310053
"x1shift": {
10054-
"description": "Only relevant if xref is a (multi-)category axes. Shifts x1 by a fraction of the reference unit.",
10054+
"description": "Only relevant if `xref` is a (multi-)category axes. Shifts `x1` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
1005510055
"dflt": 0,
1005610056
"editType": "calc",
1005710057
"max": 1,
@@ -10088,7 +10088,7 @@
1008810088
"valType": "any"
1008910089
},
1009010090
"y0shift": {
10091-
"description": "Only relevant if yref is a (multi-)category axes. Shifts y0 by a fraction of the reference unit.",
10091+
"description": "Only relevant if `yref` is a (multi-)category axes. Shifts `y0` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
1009210092
"dflt": 0,
1009310093
"editType": "calc",
1009410094
"max": 1,
@@ -10101,7 +10101,7 @@
1010110101
"valType": "any"
1010210102
},
1010310103
"y1shift": {
10104-
"description": "Only relevant if yref is a (multi-)category axes. Shifts y1 by a fraction of the reference unit.",
10104+
"description": "Only relevant if `yref` is a (multi-)category axes. Shifts `y1` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
1010510105
"dflt": 0,
1010610106
"editType": "calc",
1010710107
"max": 1,

0 commit comments

Comments
 (0)