Improve format and re-add docstrings

karlseguin · karlseguin · commit fafd8c4af19e · 2025-02-06T09:57:04.000+08:00
Implements RP suggestions.
diff --git a/src/browser/dump.zig b/src/browser/dump.zig
@@ -157,13 +157,25 @@ fn writeEscapedAttributeValue(writer: anytype, value: []const u8) !void {
 
 const testing = std.testing;
 test "dump.writeHTML" {
-    try testWriteHTML("<div id=\"content\">Over 9000!</div>", "<div id=\"content\">Over 9000!</div>");
-
-    try testWriteHTML("<root><!-- a comment --></root>", "<root><!-- a comment --></root>");
-
-    try testWriteHTML("<p>&lt; &gt; &amp;</p>", "<p>&lt; &gt; &amp;</p>");
-
-    try testWriteHTML("<p id=\"&quot;&gt;&lt;&amp;&quot;''\">wat?</p>", "<p id='\">&lt;&amp;&quot;&#39;&apos;'>wat?</p>");
+    try testWriteHTML(
+        "<div id=\"content\">Over 9000!</div>",
+        "<div id=\"content\">Over 9000!</div>",
+    );
+
+    try testWriteHTML(
+        "<root><!-- a comment --></root>",
+        "<root><!-- a comment --></root>",
+    );
+
+    try testWriteHTML(
+        "<p>&lt; &gt; &amp;</p>",
+        "<p>&lt; &gt; &amp;</p>",
+    );
+
+    try testWriteHTML(
+        "<p id=\"&quot;&gt;&lt;&amp;&quot;''\">wat?</p>",
+        "<p id='\">&lt;&amp;&quot;&#39;&apos;'>wat?</p>",
+    );
 
     try testWriteFullHTML(
         \\<!DOCTYPE html>
@@ -173,8 +185,12 @@ test "dump.writeHTML" {
     , "<html><title>It's over what?</title><meta name=a value=\"b\">\n<body>9000");
 }
 
-fn testWriteHTML(comptime expected: []const u8, src: []const u8) !void {
-    return testWriteFullHTML("<!DOCTYPE html>\n<html><head></head><body>" ++ expected ++ "</body></html>\n", src);
+fn testWriteHTML(comptime expected_body: []const u8, src: []const u8) !void {
+    const expected =
+        "<!DOCTYPE html>\n<html><head></head><body>" ++
+        expected_body ++
+        "</body></html>\n";
+    return testWriteFullHTML(expected, src);
 }
 
 fn testWriteFullHTML(comptime expected: []const u8, src: []const u8) !void {
diff --git a/src/generate.zig b/src/generate.zig
@@ -17,8 +17,14 @@
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 const std = @import("std");
+
+// ----
 const Type = std.builtin.Type;
 
+// Union
+// -----
+
+// Generate a flatten tagged Union from a Tuple
 pub fn Union(interfaces: anytype) type {
     // @setEvalBranchQuota(10000);
     const tuple = Tuple(interfaces){};
@@ -57,7 +63,7 @@ pub fn Union(interfaces: anytype) type {
         .decls = &.{},
         .is_exhaustive = true,
     };
-    const enum_T = @Type(std.builtin.Type{ .Enum = enum_info });
+    const enum_T = @Type(.{ .Enum = enum_info });
 
     // third iteration to generate union type
     var union_fields: [fields.len]Type.UnionField = undefined;
@@ -81,6 +87,12 @@ pub fn Union(interfaces: anytype) type {
     } });
 }
 
+// Tuple
+// -----
+
+// Flattens and depuplicates a list of nested tuples. For example
+// input: {A, B, {C, B, D}, {A, E}}
+// output {A, B, C, D, E}
 pub fn Tuple(args: anytype) type {
     @setEvalBranchQuota(100000);
 
