From b63667dda33aa8b2f9aafd5923f8c3b9034e90db Mon Sep 17 00:00:00 2001 From: ominitay <37453713+ominitay@users.noreply.github.com> Date: Tue, 23 Aug 2022 18:42:46 +0100 Subject: [PATCH] autodocs: improve first-line descriptions --- lib/docs/main.js | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/lib/docs/main.js b/lib/docs/main.js index 5a3572a629..cd8af7c8e9 100644 --- a/lib/docs/main.js +++ b/lib/docs/main.js @@ -2835,16 +2835,20 @@ var zigAnalysis; function shortDescMarkdown(docs) { const trimmed_docs = docs.trim(); - let index = trimmed_docs.indexOf("."); - if (index < 0) { - index = trimmed_docs.indexOf("\n"); - if (index < 0) { - index = trimmed_docs.length; - } - } else { - index += 1; // include the period + let index = trimmed_docs.indexOf("\n\n"); + let cut = false; + + if (index < 0 || index > 80) { + if (trimmed_docs.length > 80) { + index = 80; + cut = true; + } else { + index = trimmed_docs.length; + } } - const slice = trimmed_docs.slice(0, index); + + let slice = trimmed_docs.slice(0, index); + if (cut) slice += "..."; return markdown(slice); }