mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-02-13 04:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12601 from ominitay/autodocs-shortdesc

Browse Source 
autodocs: improve first-line descriptions
This commit is contained in:
Loris Cro 2022-08-26 16:35:00 +02:00 committed by GitHub
commit a69a16c6bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lib/docs/main.js
View File

@ -2839,16 +2839,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);
}