Fix up the comment to match the acceptance of returning objects other than just offsets.

This commit is contained in:
Mike Auty
2016-08-17 20:05:23 +01:00
parent 462295fc4b
commit 0fd0fa0d55
+2 -2
View File
@@ -14,8 +14,8 @@ class ScannerInterface(validity.ValidityRoutines, metaclass = ABCMeta):
"""Class for layer scanners that return locations of particular values from within the data
These are designed to be given a chunk of data and return a generator which yields
any found offsets. They should perform complex/time-consuming tasks, these should
be carried out by the consumer of the generator, so only offsets are returned.
any found items. They should NOT perform complex/time-consuming tasks, these should
be carried out by the consumer of the generator on the items returned.
They will be provided all *available* data (therefore not necessarily contiguous)
in ascending offset order, in chunks no larger than chunk_size + overlap where