From 576266927a53aba4c0d81ed9641a9435df84baa4 Mon Sep 17 00:00:00 2001 From: Jing Zhao Date: Mon, 8 May 2017 13:33:54 -0700 Subject: [PATCH 1/2] Grammar fixes to rustc-ux-guidelines.md 1) changed "long way into" to "long way toward" 2) changed "developer lives" to "developers' lives" 3) removed the "either... or..." format from second paragraph because there are more than 2 options 4) Minor revisions to paragraphs 3-6 to make them more consistent in format and to fix minor grammar issues. --- src/doc/rustc-ux-guidelines.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/doc/rustc-ux-guidelines.md b/src/doc/rustc-ux-guidelines.md index 0b2069e25aaf8..ecfb2fb25728b 100644 --- a/src/doc/rustc-ux-guidelines.md +++ b/src/doc/rustc-ux-guidelines.md @@ -1,14 +1,14 @@ % Rustc UX guidelines Don't forget the user. Whether human or another program, such as an IDE, a -good user experience with the compiler goes a long way into making developer -lives better. We don't want users to be baffled by compiler output or +good user experience with the compiler goes a long way toward making developers' +lives better. We do not want users to be baffled by compiler output or learn arcane patterns to compile their program. ## Error, Warning, Help, Note Messages -When the compiler detects a problem, it can emit either an error, warning, -note, or help message. +When the compiler detects a problem, it can emit one of the following: an error, a warning, +a note, or a help message. An `error` is emitted when the compiler detects a problem that makes it unable to compile the program, either because the program is invalid or the @@ -17,11 +17,11 @@ An `error` is emitted when the compiler detects a problem that makes it unable A `warning` is emitted when the compiler detects something odd about a program. For instance, dead code and unused `Result` values. -A `help` is emitted following either an `error` or `warning` giving extra +A `help` message is emitted following an `error` or `warning` to give additional information to the user about how to solve their problem. -A `note` is for identifying additional circumstances and parts of the code -that lead to a warning or error. For example, the borrow checker will note any +A `note` to emitted to identify additional circumstances and parts of the code +that caused the warning or error. For example, the borrow checker will note any previous conflicting borrows. * Write in plain simple English. If your message, when shown on a – possibly From 9b8f9b7cf8c9f6d73e67369b6cf57efbc154512a Mon Sep 17 00:00:00 2001 From: Jing Zhao Date: Mon, 8 May 2017 18:15:23 -0700 Subject: [PATCH 2/2] Update rustc-ux-guidelines.md "A `note` to emitted to" changed to "A `note` is emitted to" --- src/doc/rustc-ux-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/rustc-ux-guidelines.md b/src/doc/rustc-ux-guidelines.md index ecfb2fb25728b..323d49e469120 100644 --- a/src/doc/rustc-ux-guidelines.md +++ b/src/doc/rustc-ux-guidelines.md @@ -20,7 +20,7 @@ program. For instance, dead code and unused `Result` values. A `help` message is emitted following an `error` or `warning` to give additional information to the user about how to solve their problem. -A `note` to emitted to identify additional circumstances and parts of the code +A `note` is emitted to identify additional circumstances and parts of the code that caused the warning or error. For example, the borrow checker will note any previous conflicting borrows.