Skip to content

Commit 7f30703

Browse files
authored
Rollup merge of #41836 - jz0425:master, r=frewsxcv
@bors: r+ 38fe8d2 rollup 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.
2 parents 0a59fc1 + 9b8f9b7 commit 7f30703

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/doc/rustc-ux-guidelines.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
% Rustc UX guidelines
22

33
Don't forget the user. Whether human or another program, such as an IDE, a
4-
good user experience with the compiler goes a long way into making developer
5-
lives better. We don't want users to be baffled by compiler output or
4+
good user experience with the compiler goes a long way toward making developers'
5+
lives better. We do not want users to be baffled by compiler output or
66
learn arcane patterns to compile their program.
77

88
## Error, Warning, Help, Note Messages
99

10-
When the compiler detects a problem, it can emit either an error, warning,
11-
note, or help message.
10+
When the compiler detects a problem, it can emit one of the following: an error, a warning,
11+
a note, or a help message.
1212

1313
An `error` is emitted when the compiler detects a problem that makes it unable
1414
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
1717
A `warning` is emitted when the compiler detects something odd about a
1818
program. For instance, dead code and unused `Result` values.
1919

20-
A `help` is emitted following either an `error` or `warning` giving extra
20+
A `help` message is emitted following an `error` or `warning` to give additional
2121
information to the user about how to solve their problem.
2222

23-
A `note` is for identifying additional circumstances and parts of the code
24-
that lead to a warning or error. For example, the borrow checker will note any
23+
A `note` is emitted to identify additional circumstances and parts of the code
24+
that caused the warning or error. For example, the borrow checker will note any
2525
previous conflicting borrows.
2626

2727
* Write in plain simple English. If your message, when shown on a – possibly

0 commit comments

Comments
 (0)