aboutsummaryrefslogtreecommitdiffstats
path: root/bsie/base/extractor.py
diff options
context:
space:
mode:
Diffstat (limited to 'bsie/base/extractor.py')
-rw-r--r--bsie/base/extractor.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/bsie/base/extractor.py b/bsie/base/extractor.py
index 75b7173..bfa403c 100644
--- a/bsie/base/extractor.py
+++ b/bsie/base/extractor.py
@@ -20,7 +20,7 @@ __all__: typing.Sequence[str] = (
# constants
# essential definitions typically used in extractor schemas.
-# NOTE: The definition here is only for convenience; Each Extractor must implement its use, if so desired.
+# NOTE: This preamble is only for convenience; Each Extractor must implement its use, if so desired.
SCHEMA_PREAMBLE = '''
# common external prefixes
prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
@@ -45,7 +45,12 @@ SCHEMA_PREAMBLE = '''
## code ##
class Extractor(abc.ABC):
- """Produce (node, predicate, value)-triples from some content."""
+ """Produce (subject, predicate, value)-triples from some content.
+ The Extractor produces princpal predicates that provide information
+ about the content itself (i.e., triples that include the subject),
+ and may also generate triples with auxiliary predicates if the
+ extracted value is a node itself.
+ """
# what type of content is expected (i.e. reader subclass).
CONTENT_READER: typing.Optional[str] = None