Skip to content
Permalink
Browse files

improve documentation summaries

  • Loading branch information...
sdpython committed Oct 2, 2017
1 parent b1b4ba2 commit 23bd2ccc6f5001a93ec83431d32601f30302f4bf
Showing with 5 additions and 0 deletions.
  1. +5 −0 src/pyquickhelper/helpgen/utils_sphinx_doc_helpers.py
@@ -103,6 +103,9 @@ def compute_truncated_documentation(doc, length=_length_truncated_doc,
if "@brief " in doc:
doc = doc.split("@brief ")
doc = doc[-1]
if ":githublink:" in doc:
doc = doc.split(":githublink:")
doc = doc[-1]

doc = doc.strip("\n\r\t ").replace("\t", " ")

@@ -147,6 +150,8 @@ def filter_line(line):
i += 1
doc += "..."

doc = re.sub(' +', ' ', doc)

if raise_exception and len(doc) == 0:
raise ValueError("bad format for docstring: " + doc_)

0 comments on commit 23bd2cc

Please sign in to comment.
You can’t perform that action at this time.