Guide: Cleanup and proofread #18778
Guide: Cleanup and proofread #18778
Conversation
| @@ -133,7 +133,8 @@ the documentation for your shell for more details. | |||
|
|
|||
| Let's make a new source file next. I'm going to use the syntax `editor | |||
| filename` to represent editing a file in these examples, but you should use | |||
| whatever method you want. We'll call our file `main.rs`: | |||
| whatever method you want (if you are new to *nix try out emacs or vim investing | |||
There was a problem hiding this comment.
People may not know what "_nix" is, and it would be "_NIX" anyway ;)
Also, this isn't the place for vim or emacs promotion, and they would need graves around them.
There was a problem hiding this comment.
Since talked a little about basic shell use before, I thought adding editor recommandations appropriate there (and I simply put vim and emacs as they are the most common)
gamazeps
force-pushed
the
doc_cleanup
branch
2 times, most recently
from
4ee1fa6 to
2ae6384
Compare
| What about returning a value? | ||
|
|
||
| Rust functions return exactly one value, which type is declared after an arrow (a | ||
| dash (`-`) followed by a greater that sign (`>`)) in the function declaration. |
There was a problem hiding this comment.
Why not just writing it out as ->?
gamazeps
force-pushed
the
doc_cleanup
branch
3 times, most recently
from
5d9aeeb to
5ef93ed
Compare
|
Done :) |
| @@ -133,7 +133,8 @@ the documentation for your shell for more details. | |||
|
|
|||
| Let's make a new source file next. I'm going to use the syntax `editor | |||
| filename` to represent editing a file in these examples, but you should use | |||
| whatever method you want. We'll call our file `main.rs`: | |||
| whatever method you want (if you are new to *NIX try out emacs or vim investing | |||
| time in them really is useful). We'll call our file `main.rs`: | |||
There was a problem hiding this comment.
We're still doing evangelism here. This change just isn't good, sorry :/
|
I've already commented to @steveklabnik about the punctuation around quotes, but it's relevant here, too. Uncyclopedia mandates "logical" punctuation for everything, regardless of topic or English dialect. I took a look at the GNU Coding Standards, Python's PEPs, and the documentation for GHC; I don't know that any of those have explicitly have a standard, but all of those use logical punctuation in the first several examples I could find, despite otherwise preferring American English. I have trouble thinking of a major software project that mandates the traditional "American" punctuation. Some American style guides (e.g. The Chicago Manual of Style) also recommend that periods should be placed outside quotations marks in cases where placing the period inside could change the meaning of the quoted text, such as for code snippets and file names. So the point is, if Rust documentation requires commas/periods inside quotes, that won't really be "standard" American usage. Rather it will make Rust the odd man out in this respect. |
|
@gamazeps this needs a rebase, and also has some unaddressed comments. |
|
Closing due to inactivity, but feel free to reopen with a rebase and comments addressed! |
fix: Fix flycheck diagnostics flickering for binary targets
First half for now