From 6a3d8d28b5a89d5fe3a97b9e4539cde27995ddb6 Mon Sep 17 00:00:00 2001 From: Turiiya <34311583+ttytm@users.noreply.github.com> Date: Mon, 8 Apr 2024 11:48:01 +0200 Subject: [PATCH] vdoc: fix indentation in module readmes (#21220) --- cmd/tools/vdoc/html.v | 6 +- .../tests/testdata/output_formats/README.md | 2 +- .../tests/testdata/output_formats/main.ansi | 4 +- .../tests/testdata/output_formats/main.html | 56 +++++++++---------- .../tests/testdata/output_formats/main.text | 2 +- 5 files changed, 34 insertions(+), 36 deletions(-) diff --git a/cmd/tools/vdoc/html.v b/cmd/tools/vdoc/html.v index a0fe49456f..3cb5f5b0b0 100644 --- a/cmd/tools/vdoc/html.v +++ b/cmd/tools/vdoc/html.v @@ -18,7 +18,6 @@ const link_svg = '', '`', '', '`'] enum HighlightTokenTyp { unone @@ -500,13 +499,12 @@ fn html_highlight(code string, tb &ast.Table) string { fn doc_node_html(dn doc.DocNode, link string, head bool, include_examples bool, tb &ast.Table) string { mut dnw := strings.new_builder(200) head_tag := if head { 'h1' } else { 'h2' } - comments := dn.merge_comments_without_examples() // Allow README.md to go through unescaped except for script tags escaped_html := if head && is_module_readme(dn) { // Strip markdown [TOC] directives, since we generate our own. - comments.replace('[TOC]', '').replace_each(md_script_escape_seq) + dn.comments[0].text } else { - comments + dn.merge_comments() } mut renderer := markdown.HtmlRenderer{ transformer: &MdHtmlCodeHighlighter{ diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/README.md b/cmd/tools/vdoc/tests/testdata/output_formats/README.md index bb231c335e..36f2f416ed 100644 --- a/cmd/tools/vdoc/tests/testdata/output_formats/README.md +++ b/cmd/tools/vdoc/tests/testdata/output_formats/README.md @@ -7,7 +7,7 @@ This is a [link](https://vlang.io/) to the main V site. This is a bold text. -This is a script . +This is a script `` . ## Examples diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi b/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi index 6b4660b3ec..69f5d594d5 100644 --- a/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi +++ b/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi @@ -3,7 +3,7 @@ This is an example of a an .md file, used for adding more rich text documentation in a project or module. This is a link to the main V site. This is a bold text. -This is a script console.log('hi from README.md'); . +This is a script . Examples Processing command line args import os @@ -68,7 +68,7 @@ fn auth_verify(secret string, token string) bool { This is a bold text. - This is a script . + This is a script `` . ## Examples diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.html b/cmd/tools/vdoc/tests/testdata/output_formats/main.html index 5d90b76eee..748c7180a2 100644 --- a/cmd/tools/vdoc/tests/testdata/output_formats/main.html +++ b/cmd/tools/vdoc/tests/testdata/output_formats/main.html @@ -1,11 +1,11 @@

main #

-

Description

This is an example of a an .md file, used for adding more rich text documentation in a project or module.

This is a link to the main V site.

This is a bold text.

This is a script console.log('hi from README.md'); .

Examples

Processing command line args

import os
+
Description
This is an example of a an .md file, used for adding more rich textdocumentation in a project or module.
This is a link to the main V site.
This is a bold text.
This is a script <script>console.log('hi from README.md');</script> .
Examples
Processing command line args
import os
 
 fn main() {
-dump(os.args)
-dump(os.args.len)
-assert os.args.len &gt; 0
+    dump(os.args)
+    dump(os.args.len)
+    assert os.args.len &gt; 0
 }
A JWT example (test syntax highlighting)
import crypto.hmac
 import crypto.sha256
 import encoding.base64
@@ -13,42 +13,42 @@
 import time
 
 struct JwtHeader {
-alg string
-typ string
+    alg string
+    typ string
 }
 
 struct JwtPayload {
-sub  string
-name string
-iat  int
+    sub  string
+    name string
+    iat  int
 }
 
 fn main() {
-sw := time.new_stopwatch()
-secret := 'your-256-bit-secret'
-token := make_token(secret)
-ok := auth_verify(secret, token)
-dt := sw.elapsed().microseconds()
-println('token: ${token}')
-println('auth_verify(secret, token): ${ok}')
-println('Elapsed time: ${dt} uS')
+    sw := time.new_stopwatch()
+    secret := 'your-256-bit-secret'
+    token := make_token(secret)
+    ok := auth_verify(secret, token)
+    dt := sw.elapsed().microseconds()
+    println('token: ${token}')
+    println('auth_verify(secret, token): ${ok}')
+    println('Elapsed time: ${dt} uS')
 }
 
 fn make_token(secret string) string {
-header := base64.url_encode(json.encode(JwtHeader{'HS256', 'JWT'}).bytes())
-payload := base64.url_encode(json.encode(JwtPayload{'1234567890', 'John Doe', 1516239022}).bytes())
-signature := base64.url_encode(hmac.new(secret.bytes(),'${header}.${payload}'.bytes(),
-sha256.sum, sha256.block_size))
-jwt :='${header}.${payload}.${signature}'
-return jwt
+    header := base64.url_encode(json.encode(JwtHeader{'HS256', 'JWT'}).bytes())
+    payload := base64.url_encode(json.encode(JwtPayload{'1234567890', 'John Doe', 1516239022}).bytes())
+    signature := base64.url_encode(hmac.new(secret.bytes(),'${header}.${payload}'.bytes(),
+        sha256.sum, sha256.block_size))
+    jwt :='${header}.${payload}.${signature}'
+    return jwt
 }
 
 fn auth_verify(secret string, token string) bool {
-token_split := token.split('.')
-signature_mirror := hmac.new(secret.bytes(),'${token_split[0]}.${token_split[1]}'.bytes(),
-sha256.sum, sha256.block_size)
-signature_from_token := base64.url_decode(token_split[2])
-return hmac.equal(signature_from_token, signature_mirror)
+    token_split := token.split('.')
+    signature_mirror := hmac.new(secret.bytes(),'${token_split[0]}.${token_split[1]}'.bytes(),
+        sha256.sum, sha256.block_size)
+    signature_from_token := base64.url_decode(token_split[2])
+    return hmac.equal(signature_from_token, signature_mirror)
 }
diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.text b/cmd/tools/vdoc/tests/testdata/output_formats/main.text index 11236b694b..3ae31777ee 100644 --- a/cmd/tools/vdoc/tests/testdata/output_formats/main.text +++ b/cmd/tools/vdoc/tests/testdata/output_formats/main.text @@ -7,7 +7,7 @@ module main This is a bold text. - This is a script . + This is a script `` . ## Examples