From d8ef340d997a0f9d29f2372eda95a9d11bb0fcb8 Mon Sep 17 00:00:00 2001 From: Sam Robinson-Adams Date: Wed, 18 May 2022 15:10:18 +0100 Subject: [PATCH] Fix rusty grammar in `std::error::Reporter` docs I initially saw "print's" instead of "prints" at the start of the doc comment for `std::error::Reporter`, while reading the docs for that type. Then I figured 'probably more where that came from', so, as well as correcting the foregoing to "prints", I've patched up these three minor solecisms (well, two [types](https://en.wikipedia.org/wiki/Type%E2%80%93token_distinction), three [tokens](https://en.wikipedia.org/wiki/Type%E2%80%93token_distinction)): - One use of the indicative which should be subjunctive - indeed the sentence immediately following it, which mirrors its structure, _does_ use the subjunctive ([L871](https://github.com/rust-lang/rust/blob/master/library/std/src/error.rs?plain=1#L871)). Replaced with the subjunctive. - Two separate clauses joined with commas ([L975](https://github.com/rust-lang/rust/blob/master/library/std/src/error.rs?plain=1#L975), [L1023](https://github.com/rust-lang/rust/blob/master/library/std/src/error.rs?plain=1#L1023)). Replaced the first with a semicolon and the second with a period. Admittedly those judgements are pretty much 100% subjective, based on my sense of how the sentences flowed into each other (though ofc the _replacement of the comma itself_ is not subjective or opinion-based). I know this is silly and finicky, but I hope it helps tidy up the docs a bit for future readers! --- library/std/src/error.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/library/std/src/error.rs b/library/std/src/error.rs index 361163d1970..438304e1664 100644 --- a/library/std/src/error.rs +++ b/library/std/src/error.rs @@ -863,12 +863,12 @@ impl dyn Error + Send + Sync { } } -/// An error reporter that print's an error and its sources. +/// An error reporter that prints an error and its sources. /// /// Report also exposes configuration options for formatting the error chain, either entirely on a /// single line, or in multi-line format with each cause in the error chain on a new line. /// -/// `Report` only requires that the wrapped error implements `Error`. It doesn't require that the +/// `Report` only requires that the wrapped error implement `Error`. It doesn't require that the /// wrapped error be `Send`, `Sync`, or `'static`. /// /// # Examples @@ -972,7 +972,7 @@ impl dyn Error + Send + Sync { /// /// ## Return from `main` /// -/// `Report` also implements `From` for all types that implement [`Error`], this when combined with +/// `Report` also implements `From` for all types that implement [`Error`]; this when combined with /// the `Debug` output means `Report` is an ideal starting place for formatting errors returned /// from `main`. /// @@ -1020,7 +1020,7 @@ impl dyn Error + Send + Sync { /// ``` /// /// **Note**: `Report`s constructed via `?` and `From` will be configured to use the single line -/// output format, if you want to make sure your `Report`s are pretty printed and include backtrace +/// output format. If you want to make sure your `Report`s are pretty printed and include backtrace /// you will need to manually convert and enable those flags. /// /// ```should_panic