Skip to content

Commit bab8020

Browse files
committed
adjust description keys and values
1 parent d06bc6d commit bab8020

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/plots/cartesian/layout_attributes.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1011,7 +1011,7 @@ module.exports = {
10111011
'Automatically reposition the axis to avoid',
10121012
'overlap with other axes with the same `overlaying` value.',
10131013
'This repositioning will account for any `shift` amount applied to other',
1014-
'axes on the same side with `autoshift=true`.',
1014+
'axes on the same side with `autoshift` is set to *true*.',
10151015
'Only has an effect if `anchor` is set to *free*.',
10161016
].join(' ')
10171017
},
@@ -1022,8 +1022,8 @@ module.exports = {
10221022
'Moves the axis a given number of pixels from where it would have been otherwise.',
10231023
'Accepts both positive and negative values, which will shift the axis either right',
10241024
'or left, respectively.',
1025-
'If `autoshift=true`, then this defaults to a padding of `-3` if `side=left`',
1026-
'and `+3` if `side=right`. Defaults to `0` if `autoshift=false`.',
1025+
'If `autoshift` is set to *true*, then this defaults to a padding of *-3* if `side` is set to *left.',
1026+
'and defaults to *+3* if `side` is set to *right*. Defaults to *0* if `autoshift` is set to *false*.',
10271027
'Only has an effect if `anchor` is set to *free*.'
10281028
].join(' ')
10291029
},

test/plot-schema.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9977,7 +9977,7 @@
99779977
]
99789978
},
99799979
"autoshift": {
9980-
"description": "Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift=true`. Only has an effect if `anchor` is set to *free*.",
9980+
"description": "Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to *true*. Only has an effect if `anchor` is set to *free*.",
99819981
"dflt": false,
99829982
"editType": "plot",
99839983
"valType": "boolean"
@@ -10742,7 +10742,7 @@
1074210742
"valType": "boolean"
1074310743
},
1074410744
"shift": {
10745-
"description": "Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift=true`, then this defaults to a padding of `-3` if `side=left` and `+3` if `side=right`. Defaults to `0` if `autoshift=false`. Only has an effect if `anchor` is set to *free*.",
10745+
"description": "Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift` is set to *true*, then this defaults to a padding of *-3* if `side` is set to *left. and defaults to *+3* if `side` is set to *right*. Defaults to *0* if `autoshift` is set to *false*. Only has an effect if `anchor` is set to *free*.",
1074610746
"editType": "plot",
1074710747
"valType": "number"
1074810748
},
@@ -11239,7 +11239,7 @@
1123911239
]
1124011240
},
1124111241
"autoshift": {
11242-
"description": "Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift=true`. Only has an effect if `anchor` is set to *free*.",
11242+
"description": "Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to *true*. Only has an effect if `anchor` is set to *free*.",
1124311243
"dflt": false,
1124411244
"editType": "plot",
1124511245
"valType": "boolean"
@@ -11750,7 +11750,7 @@
1175011750
"valType": "boolean"
1175111751
},
1175211752
"shift": {
11753-
"description": "Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift=true`, then this defaults to a padding of `-3` if `side=left` and `+3` if `side=right`. Defaults to `0` if `autoshift=false`. Only has an effect if `anchor` is set to *free*.",
11753+
"description": "Moves the axis a given number of pixels from where it would have been otherwise. Accepts both positive and negative values, which will shift the axis either right or left, respectively. If `autoshift` is set to *true*, then this defaults to a padding of *-3* if `side` is set to *left. and defaults to *+3* if `side` is set to *right*. Defaults to *0* if `autoshift` is set to *false*. Only has an effect if `anchor` is set to *free*.",
1175411754
"editType": "plot",
1175511755
"valType": "number"
1175611756
},

0 commit comments

Comments
 (0)