Commit 30fc1012ae

Shun Sakai <sorairolake@protonmail.ch>
2025-01-22 15:37:04
std.zip: Replace invisible doc comments with top-level doc comments
I think it would be better if this invisible doc comments is top-level doc comments rather than doc comments. Because it is at the start of a source file. This makes the doc comments visible. However, the last paragraph replaces doc comments with normal comments. This is because I thought that normal comments would be more appropriate than top-level doc comments given the context of the last paragraph.
master
1 parent a3ad0a2
Changed files (1)
lib
std
zip.zig
lib/std/zip.zig
@@ -1,8 +1,8 @@
-/// The .ZIP File Format Specification is found here:
-///    https://pkwaredownloads.blob.core.windows.net/pem/APPNOTE.txt
-///
-/// Note that this file uses the abbreviation "cd" for "central directory"
-///
+//! The .ZIP File Format Specification is found here:
+//!    https://pkwaredownloads.blob.core.windows.net/pem/APPNOTE.txt
+
+// Note that this file uses the abbreviation "cd" for "central directory"
+
 const builtin = @import("builtin");
 const std = @import("std");
 const testing = std.testing;