Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 44568ad

Browse files
committed
changed descriptions of some histogram parameters
1 parent 7f7c2fe commit 44568ad

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

src/traces/histogram/attributes.js

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,21 @@ module.exports = {
8282
role: 'style',
8383
description: [
8484
'Determines whether or not the x axis bin attributes are picked',
85-
'by an algorithm.'
86-
].join(' ')
85+
'by an algorithm. Note that this should be set to false if you',
86+
'want to manually set the number of bins using the attributes in',
87+
'xbins'
88+
].join(' ')
8789
},
8890
nbinsx: {
8991
valType: 'integer',
9092
min: 0,
9193
dflt: 0,
9294
role: 'style',
93-
description: 'Sets the number of x axis bins.'
95+
description: [
96+
'Specifies the desired amount of bins. This value will be used',
97+
'in an algorithm that will decide the optimal bin size such that the',
98+
'histogram best visualizes the distribution of the data'
99+
]
94100
},
95101
xbins: makeBinsAttr('x'),
96102

@@ -99,16 +105,22 @@ module.exports = {
99105
dflt: true,
100106
role: 'style',
101107
description: [
102-
'Determines whether or not the y axis bin attributes are picked',
103-
'by an algorithm.'
108+
'Determines whether or not the y axis bin attributes are picked',
109+
'by an algorithm. Note that this should be set to false if you',
110+
'want to manually set the number of bins using the attributes in',
111+
'ybins'
104112
].join(' ')
105113
},
106114
nbinsy: {
107115
valType: 'integer',
108116
min: 0,
109117
dflt: 0,
110118
role: 'style',
111-
description: 'Sets the number of y axis bins.'
119+
description: [
120+
'Specifies the desired amount of bins. This value will be used',
121+
'in an algorithm that will decide the optimal bin size such that the',
122+
'histogram best visualizes the distribution of the data'
123+
]
112124
},
113125
ybins: makeBinsAttr('y'),
114126

0 commit comments

Comments
 (0)