indexing_lister: Add docstrings to flush_packet_db & default_min_bound

Related D1635
This commit is contained in:
Antoine R. Dumont (@ardumont) 2019-06-26 11:27:41 +02:00
parent 3d473c307c
commit e54531510c
No known key found for this signature in database
GPG key ID: 52E2E9840D10C3B8

View file

@ -16,8 +16,6 @@ logger = logging.getLogger(__name__)
class IndexingLister(ListerBase):
flush_packet_db = 20
default_min_bound = ''
"""Lister* intermediate class for any service that follows the pattern:
- The service must report at least one stable unique identifier, known
@ -47,6 +45,14 @@ class IndexingLister(ListerBase):
def get_next_target_from_response
"""
flush_packet_db = 20
"""Number of iterations in-between write flushes of lister repositories to
db (see fn:`run`).
"""
default_min_bound = ''
"""Default initialization value for the minimum boundary index to use when
undefined (see fn:`run`).
"""
@abc.abstractmethod
def get_next_target_from_response(self, response):