Fix invisible doccomments at the start of source files to make them visible #22573
+9
−9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…vel 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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I was looking at
lib/std/compress/flate/Lookup.zigandlib/std/zip.zigin https://ziglang.org/documentation/master/std/, I noticed that the doc comments at the start of them were not visible.I think it would be better if these doc comments is top-level doc comments rather than doc comments. Because it is at the start of the source file. Also, given the context, I don't think these are doc comments for
const std = @import("std");andconst builtin = @import("builtin");. This makes these doc comments visible.However, the last paragraph of doc comments in
lib/std/zip.zigreplaces 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.