From e54531510c91205635fd03b91504f84e9ade0d7a Mon Sep 17 00:00:00 2001
From: "Antoine R. Dumont (@ardumont)" <antoine.romain.dumont@gmail.com>
Date: Wed, 26 Jun 2019 11:27:41 +0200
Subject: [PATCH] indexing_lister: Add docstrings to flush_packet_db &
default_min_bound
Related D1635
---
swh/lister/core/indexing_lister.py | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/swh/lister/core/indexing_lister.py b/swh/lister/core/indexing_lister.py
index 5436da1f..21d4a82a 100644
--- a/swh/lister/core/indexing_lister.py
+++ b/swh/lister/core/indexing_lister.py
@@ -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):
--
GitLab