docs(clippy_utils): Add documentation for ast_utils #15588
Conversation
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
rustbot
added
the
S-waiting-on-review
samueltardieu
requested changes
Aug 29, 2025
There was a problem hiding this comment.
Thanks for the initiative.
However, the comments could be more useful for the user. Also, don't use the "fixes …" in the PR description, it doesn't fix it, it is just a small part of what needs to be done, the issue should not be auto-closed.
r? samueltardieu
@rustbot author
| @@ -287,14 +302,17 @@ pub fn eq_arm(l: &Arm, r: &Arm) -> bool { | |||
| && over(&l.attrs, &r.attrs, eq_attr) | |||
| } | |||
|
|
|||
| /// Returns `true` if the two given optional `[Label]` nodes are structurally equivalent. | |||
There was a problem hiding this comment.
Those comments are not really useful. It would be more useful to indicate what happens when both labels are defined with the same identifier name, and when both of them are None. It is not clear here if two None are "structurally equivalent" just from reading the comment.
rustbot
added
S-waiting-on-author
|
Reminder, once the PR becomes ready for a review, use |
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.
Fixes #15569
This PR resolves the
missing_docswarnings for theclippy_utils::ast_utilsmodule.#![warn(missing_docs)]lint on the module.ident_itersubmodule.This makes the utility functions easier to understand and helps maintain documentation coverage for the crate.