Convert some module doc comments #5999
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
Some module doc comments were using `/*! ... */` syntax and had leading ` *` prefixes on each line. This interferes with the tracking of `clippy::doc_lazy_continuation`, so switch those over to `//!` style comment blocks. This leaves `/*! ... */` blocks alone which didn't prefix each line.
|
Going to specifically cc @jimblandy on this one - I don't see why we shouldn't accept this though. |
|
A couple of these blocks will have warnings in Rust 1.80 which is what led me down this path. |
nical
approved these changes
Jul 22, 2024
6 tasks
ErichDonGubler
approved these changes
Jul 24, 2024
|
Going to specifically merge (🙃), and deal with any fallout that @jimblandy would like to impose. I think it's valuable to adhere to the convention that Rust upstream imposes by default, be internally consistent in the format of documentation that we have for ourselves, and avoid warnings from |
|
@ErichDonGubler Thanks. There are still a number of files that use a similar syntax, but they don't indent and put a I targeted these as some of them introduced lint failures in 1.80 with |
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.
Description
Some module doc comments were using
/*! ... */syntax and had leading*prefixes on each line. This interferes with the tracking ofclippy::doc_lazy_continuation, so switch those over to//!style comment blocks.This leaves
/*! ... */blocks alone which didn't prefix each line.Testing
Explain how this change is tested.
Checklist
cargo fmt.cargo clippy. If applicable, add:--target wasm32-unknown-unknown--target wasm32-unknown-emscriptencargo xtask testto run tests.CHANGELOG.md. See simple instructions inside file.