docs(clippy_utils): Add documentation for ast_utils #15588
Conversation
rustbot
added
the
S-waiting-on-review
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
| left.len() == right.len() && left.iter().all(|l| right.iter().any(|r| eq_fn(l, r))) | ||
| } | ||
|
|
||
| /// Returns `true` if the two given `[Ident]` nodes are structurally equivalent. |
There was a problem hiding this comment.
You can use "Checks if …" instead of "return true if …" (and in other places too). Here, you can be more precise:
| /// Returns `true` if the two given `[Ident]` nodes are structurally equivalent. | |
| /// Checks if `l` and `r` have the same name. |
| && 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 |
|
☔ The latest upstream changes (possibly f3c020c) made this pull request unmergeable. Please resolve the merge conflicts. |
4 participants
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.