-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix doc nits #12880
Fix doc nits #12880
Conversation
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Alexendoo (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
/// for elem in v.iter() { | ||
/// println!("{}", elem); | ||
/// for elem in v { | ||
/// println!("{elem}"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't equivalent to the above code as it takes v
by value. The println
also should be updated in both if it's being changed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @Alexendoo! Good catch, changed as suggested.
@rustbot review |
Thanks! @bors r+ |
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
@Alexendoo thanks for your guidance on this one! I have a few more textual nits I've been collecting—from your point of view, what would be the best way to submit these?
Smaller PRs are faster to review, but on the other hand batching a lot of changes together reduces the admin overhead of approval and merging—as a maintainer, which do you prefer? |
I prefer single commits usually, single or multiple PRs are fine either way I'd say don't split it up into multiple PRs if you have the work done already, but also you don't have to wait until you have done everything before opening a PR. It being in several chunks is perfectly fine if it works out like that Whichever you go for, thank you for the contributions! |
Clippy is wonderful, and reading its lints is a great way to learn about Rust. While doing this, I noticed a few little copyedits, such as adding trailing periods to sentences, or tweaking wording very slightly to improve its readability. I hope you will accept these suggestions as an act of love for the project, with my thanks for all the maintainers' hard work.
changelog: Docs [ mut_range_bound ]: fix doc nits
changelog: Docs [ needless_for_each ]: fix doc nits
changelog: Docs [ arc_with_non_send_sync ]: fix doc nits
changelog: Docs [ allow_attributes ]: fix doc nits
changelog: Docs [ allow_attributes_without_reason ]: fix doc nits