Repository navigation
Remove redundant comments in the library - #1354
Merged
Merged
Conversation
Rustoleum's redundant_language_comment rule flagged 60 library files. Most of their comments give a reason, an invariant or a language rule; these ten only narrate the next line or reword a private item's name.
Three doc comments kept a superseded first version above the new one. The docs of index_write, export and name_of ended up on a function later inserted between them and their item. current_function returns a name, not an id.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Collaborator
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Delightful! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
This file contains hidden or 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
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.
Rustoleum's
redundant_language_commentrule flagged 60 library files (VIBE-100). Almost every comment in them records a budget or ordering rule, Go parity, or a test's intent, so only ten that narrate the next line or reword a private item's name are cut. Public doc comments stay.While reading the files I found six doc comments that later edits had left stale: three items kept a superseded first paragraph above its replacement, and the docs of
index_write,exportandname_ofended up on a function inserted between them and their item. A second commit fixes those, along withcurrent_function, whose doc says it returns an id when it returns a name.