get_docs_summary#

get_docs_summary(obj, with_doc_link: bool = True)[source]#

Return the docs summary if available.

Parameters
obj

an object

with_doc_linkbool , default: True

if to add doc link

Returns
——-
str

the object summary.

previous

format_datetime

next

truncate_string