Switch workerd/util to idiomatic comment style #901
Merged
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
jasnell
changed the title
harrishancock
approved these changes
Aug 18, 2023
jasnell
force-pushed
the
jsnell/comment-reformat-part-1
branch
from
5bc746f to
4bda277
Compare
jasnell
changed the title
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.
Wanted to get a sense of how difficult and time consuming it would be to manually convert the comment style to the more idiomatic comments-before-declarations style. Turns out it's rather quick and generally painless. This batch took about 30 minutes with several interruptions. Most of it is purely mechanical. In a few cases it's obvious that a tool would be difficult since some comments are obviously impl details that do, for instance, belong inside a function body, while others are clearly meant to describe the declaration. Some judgement is required to pick those out case by case but it seems to be rather painless overall.