Skip to content

Commit a636c7f

Browse files
committed
docs: improve the documentation for extractRegexpValues accumulator
1 parent 36d64d6 commit a636c7f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Rule.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,10 @@ Rule.addAccumulator = function (methodName, methodBuilder) {
135135
};
136136

137137
/**
138-
* This accumulator will store the values extracted by the regexp of the Rule object,
138+
* This accumulator will store the group values extracted by the regexp of the Rule object,
139139
* on the current matching PDF item, into an array.
140+
*
141+
* E.g. with regex: /hello ([a-z]+)/, the text "hello world" will yield "world".
140142
**/
141143
Rule.addAccumulator("extractRegexpValues", function () {
142144
var matches = this.regexp.exec(this.currentItem.text);

0 commit comments

Comments
 (0)