nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-05-14 02:49:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Grammar fixes to rustc-ux-guidelines.md

Browse Source 
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.
This commit is contained in:
Jing Zhao 2017-05-08 13:33:54 -07:00 committed by GitHub
parent 198917bb4f
commit 576266927a
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/doc/rustc-ux-guidelines.md
View File

@ -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