aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2019-12-14 18:18:31 +0100
committerMartin Czygan <martin.czygan@gmail.com>2019-12-14 18:18:31 +0100
commit44c0847758bd4326c168ce8b95cd3dbfdf9b5062 (patch)
tree0ec86fdbfdb7c0db923dbe66760693cc87593f9e
parentc642052f1b7df58ef38b5f16a5f2a198d9960666 (diff)
downloadfatcat-44c0847758bd4326c168ce8b95cd3dbfdf9b5062.tar.gz
fatcat-44c0847758bd4326c168ce8b95cd3dbfdf9b5062.zip
complete parse_record docstring
-rw-r--r--python/fatcat_tools/importers/common.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/python/fatcat_tools/importers/common.py b/python/fatcat_tools/importers/common.py
index c9648173..073725ad 100644
--- a/python/fatcat_tools/importers/common.py
+++ b/python/fatcat_tools/importers/common.py
@@ -320,6 +320,12 @@ class EntityImporter:
return
def parse_record(self, raw_record):
+ """
+ Returns an entity class type, or None if we should skip this one.
+
+ May have side-effects (eg, create related entities), but shouldn't
+ update/mutate the actual entity.
+ """
# implementations should fill this in
raise NotImplementedError