def process_doc(cls, doc, handler):
# type: (str, typing.Callable[[str, str], str]) -> typing.Text
"""
Helper for parsing documentation references in Stone docstrings and
replacing them with more suitable annotations for the generated output.
Args:
doc (str): A Stone docstring.
handler: A function with the following signature:
`(tag: str, value: str) -> str`. It will be called for every
reference found in the docstring with the tag and value parsed
for you. The returned string will be substituted in the
docstring in place of the reference.
"""
assert isinstance(doc, six.text_type), \
'Expected string (unicode in PY2), got %r.' % type(doc)
cur_index = 0
parts = []
for match in doc_ref_re.finditer(doc):
# Append the part of the doc that is not part of any reference.
start, end = match.span()
parts.append(doc[cur_index:start])
cur_index = end
# Call the handler with the next tag and value.
tag = match.group('tag')
val = match.group('val')
sub = handler(tag, val)
parts.append(sub)
parts.append(doc[cur_index:])
return ''.join(parts)
def process_doc(cls, doc, handler):
# type: (str, typing.Callable[[str, str], str]) -> typing.Text
"""
Helper for parsing documentation references in Stone docstrings and
replacing them with more suitable annotations for the generated output.
Args:
doc (str): A Stone docstring.
handler: A function with the following signature:
`(tag: str, value: str) -> str`. It will be called for every
reference found in the docstring with the tag and value parsed
for you. The returned string will be substituted in the
docstring in place of the reference.
"""
assert isinstance(doc, six.text_type), \
'Expected string (unicode in PY2), got %r.' % type(doc)
cur_index = 0
parts = []
for match in doc_ref_re.finditer(doc):
# Append the part of the doc that is not part of any reference.
start, end = match.span()
parts.append(doc[cur_index:start])
cur_index = end
# Call the handler with the next tag and value.
tag = match.group('tag')
val = match.group('val')
sub = handler(tag, val)
parts.append(sub)
parts.append(doc[cur_index:])
return ''.join(parts)