papyri
{ } Raw JSON

bundles / papyri 0.0.10 / papyri / doc / _normalize_see_also

function

papyri.doc:_normalize_see_also

source: /papyri/doc.py :231

Signature

def   _normalize_see_also ( see_also : Any ,  qa : str )  →  tuple[SeeAlsoItem, ...]

Summary

numpydoc is complex, the See Also fields can be quite complicated, so here we sort of try to normalise them. from what I can remember, See also can have name1 : type1 name2 : type2 description for both name1 and name 2.

Extended Summary

Though if description is empty, them the type is actually the description.

Aliases

  • papyri.doc._normalize_see_also