Skip to content

Commit 32293e3

Browse files
authored
Merge pull request #623 from yankev/histogram-parameter-descriptions
Changing Histogram parameter descriptions
2 parents bcde048 + 293ce37 commit 32293e3

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

src/traces/histogram/attributes.js

Lines changed: 16 additions & 4 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.'
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.'
8688
].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 maximum number of desired 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+
].join(' ')
94100
},
95101
xbins: makeBinsAttr('x'),
96102

@@ -100,15 +106,21 @@ module.exports = {
100106
role: 'style',
101107
description: [
102108
'Determines whether or not the y axis bin attributes are picked',
103-
'by an algorithm.'
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 maximum number of desired 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+
].join(' ')
112124
},
113125
ybins: makeBinsAttr('y'),
114126

0 commit comments

Comments
 (0)