From 30fc1012ae28afcff6178997287bb7daeef077f6 Mon Sep 17 00:00:00 2001 From: Shun Sakai Date: Wed, 22 Jan 2025 23:37:04 +0900 Subject: [PATCH] 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. --- lib/std/zip.zig | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/std/zip.zig b/lib/std/zip.zig index 2f3f4d9dcd..bafd427262 100644 --- a/lib/std/zip.zig +++ b/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;