Add more docs for msrvs.rs #16030
Open
Add more docs for msrvs.rs #16030
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
Collaborator
Jarcho
requested changes
Nov 7, 2025
Comment on lines
+135
to
149
| /// Reads the MSRV from Cargo.toml and merges it with the existing configuration | ||
| /// | ||
| /// This method checks the `CARGO_PACKAGE_RUST_VERSION` environment variable set by Cargo | ||
| /// and integrates it with the MSRV from `clippy.toml` according to these rules: | ||
| /// | ||
| /// - If only Cargo.toml specifies an MSRV, it will be used | ||
| /// - If both Cargo.toml and clippy.toml specify an MSRV and they differ, a warning is emitted | ||
| /// and the value from `clippy.toml` takes precedence | ||
| /// - If neither specifies an MSRV, no change occurs | ||
| /// | ||
| /// # Note | ||
| /// | ||
| /// This should be called during lint pass initialization to ensure the MSRV from Cargo.toml | ||
| /// is properly considered alongside the clippy.toml configuration | ||
| pub fn read_cargo(&mut self, sess: &Session) { |
Contributor
There was a problem hiding this comment.
This is overly verbose and the function won't exist here after the config rewrite PR is merged.
Comment on lines
+191
to
+194
| /// Checks if the current MSRV meets or exceeds the required version | ||
| /// | ||
| /// Returns `true` if no MSRV is configured or if the current MSRV is greater than | ||
| /// or equal to the required version |
Contributor
There was a problem hiding this comment.
Can be shortened to just "Checks if the current MSRV is either None, or is at least as high as the required version."
Comment on lines
+199
to
+202
| /// Processes attributes to update the MSRV stack when entering a new scope | ||
| /// | ||
| /// If a `#[clippy::msrv]` attribute is found, parses the version and pushes it | ||
| /// onto the stack. Also marks that MSRV attributes have been seen globally. |
Contributor
There was a problem hiding this comment.
Can be shortened to just "If the attributes contain a version attribute, pushes that version onto the stack."
A second paragraph about this being intended to be used from a lint pass's check_attributes function is also worth having.
Comment on lines
+210
to
+213
| /// Processes attributes to update the MSRV stack when leaving a scope | ||
| /// | ||
| /// If a `#[clippy::msrv]` attribute is found, pops the most recently pushed | ||
| /// MSRV from the stack, effectively restoring the previous MSRV level |
Contributor
There was a problem hiding this comment.
Can be shortened to just "If the attributes contain a version attribute, pops a version from the stack."
A second paragraph about this being intended to be used from a lint pass's check_attributes_post function is also worth having.
rustbot
added
S-waiting-on-author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
changelog: Add more docs for msrvs.rs in clippy_utils