Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@
*associated function* of` rather than `is an ‘associated function’ of`.
- When talking about a method in prose, DO NOT include the parentheses, ex:
`read_line` rather than `read_line()`.
- Hard wrap at 80 chars
- Hard wrap at 80 chars, means manually breaking lines in prose (not code) so that each line stays within 80 characters, like this:<br>
`To read a line of input, we use the read_line method from the stdin handle. This is`<br>
`an associated function of the io::stdin module.`<br>
Instead of writing everything in a single long line like:<br>
`To read a line of input, we use the read_line method from the stdin handle. This is an associated function of the io::stdin module.`
- 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`?``

Expand Down