Skip to content

Commit ba9b933

Browse files
committed
transforms: improve attribute descriptions
1 parent 104123e commit ba9b933

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

src/transforms/filter.js

+15-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ exports.attributes = {
3232
values: ['x', 'y', 'z', 'ids'],
3333
dflt: 'x',
3434
description: [
35-
'Sets the variable which the filter will be applied.'
35+
'Sets the variable in the parent trace object',
36+
'by which the filter will be applied.'
3637
].join(' ')
3738
},
3839
operation: {
@@ -69,12 +70,23 @@ exports.attributes = {
6970
dflt: 0,
7071
description: [
7172
'Sets the value or values by which to filter by.',
73+
7274
'Values are expected to be in the same type as the data linked',
7375
'to *filtersrc*.',
74-
'When `operation` is set to *within* and *notwithin*',
76+
77+
'When `operation` is set to one of the inequality values',
78+
'(' + INEQUALITY_OPS + ')',
79+
'*value* is expected to be number or a string.',
80+
81+
'When `operation` is set to one of the interval value',
82+
'(' + INTERVAL_OPS + ')',
7583
'*value* is expected to be 2-item array where the first item',
7684
'is the lower bound and the second item is the upper bound.',
77-
'When `operation`, is set to *in*, *notin* '
85+
86+
'When `operation`, is set to one of the set value',
87+
'(' + SET_OPS + ')',
88+
'*value* is expected to be an array with as many items as',
89+
'the desired set elements.'
7890
].join(' ')
7991
}
8092
};

0 commit comments

Comments
 (0)