def doc_process(docstr,
obj,
retval=True,
indent=4,
config=config,
docstring=docstring,
inspect=inspect,
process_docstring=process_docstring,
indent_text=indent_text):
docstr = docstring.GoogleDocstring(inspect.cleandoc(docstr),
config,
obj=obj)
docslines = str(docstr).splitlines()
process_docstring(None, '', '', obj, config, docslines)
if docslines:
r = docslines.pop(0)
# put rtype last
if retval:
docslines.append(r)
# indent
if indent:
docstr = indent_text(docslines, indent)
else:
docstr = "\n".join(docslines)
return docstr
def test_process_docstring_slot_wrapper():
lines = []
process_docstring(None, 'class', 'SlotWrapper', Slotted, None, lines)
assert not lines
def process(fn: t.Callable) -> t.List[str]:
lines = inspect.getdoc(fn).split("\n")
sat.process_docstring(app, "function", fn.__name__, fn, None, lines)
process_docstring(app, "function", fn.__name__, fn, None, lines)
return lines
def test_process_docstring_slotted():
lines = []
process_docstring(Config(config=Alias(sphinx_autodoc_alias={})), "class", "SlotWrapper", Slotted, None, lines)
assert not lines