Skip to content

Commit d113bcf

Browse files
committed
docstring updates
1 parent ebe85c4 commit d113bcf

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

src/components/shapes/attributes.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ module.exports = templatedArray('shape', {
301301
dflt: 3,
302302
min: 0,
303303
editType: 'arraydraw',
304-
description: 'Sets padding (in px) between edge of label and xanchor / yanchor.'
304+
description: 'Sets padding (in px) between edge of label and edge of shape.'
305305
},
306306
editType: 'arraydraw'
307307
},

src/components/shapes/draw_newshape/attributes.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ module.exports = {
8484
valType: 'string',
8585
dflt: '',
8686
editType: 'none',
87-
description: 'Sets the text to display with shape.'
87+
description: 'Sets the text to display with the new shape.'
8888
},
8989
font: fontAttrs({
9090
editType: 'none',
91-
description: 'Sets the shape label text font.'
91+
description: 'Sets the new shape label text font.'
9292
}),
9393
textposition: {
9494
valType: 'enumerated',
@@ -100,7 +100,7 @@ module.exports = {
100100
],
101101
editType: 'none',
102102
description: [
103-
'Sets the position of the label text relative to the shape.',
103+
'Sets the position of the label text relative to the new shape.',
104104
'Supported values for rectangles, circles and paths are',
105105
'`top left`, `top center`, `top right`, `middle left`,',
106106
'`middle center`, `middle right`, `bottom left`, `bottom center`,',
@@ -132,7 +132,7 @@ module.exports = {
132132
'For example, if `label.textposition` is set to *top right* and',
133133
'`xanchor` to *right* then the right-most portion of the',
134134
'label text lines up with the right-most edge of the',
135-
'shape.',
135+
'new shape.',
136136
].join(' '),
137137
},
138138
yanchor: {
@@ -146,15 +146,15 @@ module.exports = {
146146
'For example, if `label.textposition` is set to *top right* and',
147147
'`yanchor` to *top* then the top-most portion of the',
148148
'label text lines up with the top-most edge of the',
149-
'shape.',
149+
'new shape.',
150150
].join(' ')
151151
},
152152
padding: {
153153
valType: 'number',
154154
dflt: 3,
155155
min: 0,
156156
editType: 'none',
157-
description: 'Sets padding (in px) between edge of label and xanchor / yanchor.'
157+
description: 'Sets padding (in px) between edge of label and edge of new shape.'
158158
},
159159
editType: 'none'
160160
},

test/plot-schema.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3580,7 +3580,7 @@
35803580
"editType": "none",
35813581
"valType": "color"
35823582
},
3583-
"description": "Sets the shape label text font.",
3583+
"description": "Sets the new shape label text font.",
35843584
"editType": "none",
35853585
"family": {
35863586
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
@@ -3597,15 +3597,15 @@
35973597
}
35983598
},
35993599
"padding": {
3600-
"description": "Sets padding (in px) between edge of label and xanchor / yanchor.",
3600+
"description": "Sets padding (in px) between edge of label and edge of new shape.",
36013601
"dflt": 3,
36023602
"editType": "none",
36033603
"min": 0,
36043604
"valType": "number"
36053605
},
36063606
"role": "object",
36073607
"text": {
3608-
"description": "Sets the text to display with shape.",
3608+
"description": "Sets the text to display with the new shape.",
36093609
"dflt": "",
36103610
"editType": "none",
36113611
"valType": "string"
@@ -3617,7 +3617,7 @@
36173617
"valType": "angle"
36183618
},
36193619
"textposition": {
3620-
"description": "Sets the position of the label text relative to the shape. Supported values for rectangles, circles and paths are `top left`, `top center`, `top right`, `middle left`, `middle center`, `middle right`, `bottom left`, `bottom center`, and `bottom right`. Supported values for lines are `start`, `middle`, and `end`. Default: `middle center` for rectangles, circles, and paths; `middle` for lines.",
3620+
"description": "Sets the position of the label text relative to the new shape. Supported values for rectangles, circles and paths are `top left`, `top center`, `top right`, `middle left`, `middle center`, `middle right`, `bottom left`, `bottom center`, and `bottom right`. Supported values for lines are `start`, `middle`, and `end`. Default: `middle center` for rectangles, circles, and paths; `middle` for lines.",
36213621
"editType": "none",
36223622
"valType": "enumerated",
36233623
"values": [
@@ -3636,7 +3636,7 @@
36363636
]
36373637
},
36383638
"xanchor": {
3639-
"description": "Sets the label's horizontal position anchor This anchor binds the specified `label.textposition` to the *left*, *center* or *right* of the label text. For example, if `label.textposition` is set to *top right* and `xanchor` to *right* then the right-most portion of the label text lines up with the right-most edge of the shape.",
3639+
"description": "Sets the label's horizontal position anchor This anchor binds the specified `label.textposition` to the *left*, *center* or *right* of the label text. For example, if `label.textposition` is set to *top right* and `xanchor` to *right* then the right-most portion of the label text lines up with the right-most edge of the new shape.",
36403640
"dflt": "auto",
36413641
"editType": "none",
36423642
"valType": "enumerated",
@@ -3648,7 +3648,7 @@
36483648
]
36493649
},
36503650
"yanchor": {
3651-
"description": "Sets the label's vertical position anchor This anchor binds the specified `label.textposition` to the *top*, *middle* or *bottom* of the label text. For example, if `label.textposition` is set to *top right* and `yanchor` to *top* then the top-most portion of the label text lines up with the top-most edge of the shape.",
3651+
"description": "Sets the label's vertical position anchor This anchor binds the specified `label.textposition` to the *top*, *middle* or *bottom* of the label text. For example, if `label.textposition` is set to *top right* and `yanchor` to *top* then the top-most portion of the label text lines up with the top-most edge of the new shape.",
36523652
"editType": "none",
36533653
"valType": "enumerated",
36543654
"values": [
@@ -7218,7 +7218,7 @@
72187218
}
72197219
},
72207220
"padding": {
7221-
"description": "Sets padding (in px) between edge of label and xanchor / yanchor.",
7221+
"description": "Sets padding (in px) between edge of label and edge of shape.",
72227222
"dflt": 3,
72237223
"editType": "arraydraw",
72247224
"min": 0,

0 commit comments

Comments
 (0)