github_mirrors/rust-book-cn
1
0
Fork 0
mirror of https://github.com/rust-lang-cn/book-cn.git synced 2025-01-22 23:10:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update style-guide.md

Browse Source
This commit is contained in:
Carol (Nichols || Goulding) 2016-09-06 17:07:14 -04:00 committed by GitHub
parent 3ae744e99a
commit 468e5cc202
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
style-guide.md
View File

@ -6,8 +6,8 @@
Number` rather than `## Generating a secret number`. Number` rather than `## Generating a secret number`.
* Prefer italics over single quotes when calling out a term, ex: `is an * Prefer italics over single quotes when calling out a term, ex: `is an
*associated function* of` rather than `is an ‘associated function’ of`. *associated function* of` rather than `is an ‘associated function’ of`.
* When talking about a method in prose, include the parentheses, ex: * When talking about a method in prose, DO NOT include the parentheses, ex:
`read_line()` rather than `read_line`. `read_line` rather than `read_line()`.
* Hard wrap at 80 chars * Hard wrap at 80 chars
* Prefer not mixing code and not-code in one word, ex: ``Remember when we wrote * Prefer not mixing code and not-code in one word, ex: ``Remember when we wrote
`use std::io`?`` rather than ``Remember when we `use`d `std::io`?`` `use std::io`?`` rather than ``Remember when we `use`d `std::io`?``