Skip to content

Commit

Permalink
docs(segmenter): improve segmenter docstring (#1866)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoanFM committed Feb 5, 2021
1 parent 6768809 commit 8af7c41
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions jina/executors/segmenters/__init__.py
Expand Up @@ -16,11 +16,7 @@ def __init__(self, *args, **kwargs):
self.logger.warning(f'{typename(self)} works on keys, but no keys are specified')

def segment(self, *args, **kwargs) -> List[Dict]:
"""The apply function of this executor.
Unlike :class:`BaseCrafter`, the :func:`craft` here works on doc-level info and the output is defined on
chunk-level. Therefore the name of the arguments should be always valid keys defined
in the doc-level protobuf whereas the output dict keys should always be valid keys defined in the chunk-level
protobuf.
"""
:return: a list of chunks-level info represented by a dict
"""
raise NotImplementedError

0 comments on commit 8af7c41

Please sign in to comment.