about summary refs log tree commit diff
path: root/src/doc/trpl/comments.md
diff options
context:
space:
mode:
authorKevin Yap <me@kevinyap.ca>2015-01-08 16:52:50 -0800
committerKevin Yap <me@kevinyap.ca>2015-01-08 17:15:26 -0800
commit8f61814641c0fbbb929c8a04658d4ea819b4db51 (patch)
tree192edd3dd39bad177fdca131f104b039ec861985 /src/doc/trpl/comments.md
parent6354d60ede5e2a7e60fa46f85243efd8dbe89711 (diff)
downloadrust-8f61814641c0fbbb929c8a04658d4ea819b4db51.tar.gz
rust-8f61814641c0fbbb929c8a04658d4ea819b4db51.zip
Standardize punctuation & formatting of TRPL
This commit is an attempt to standardize the use of punctuation and
formatting in "The Rust Programming Language" as discussed in #19823.

- Convert bold text to italicized textcwhen referring to terminology.
- Convert single-quoted text to italicized or double-quoted text,
  depending on context.
- Use double quotes only in the case of scare quotes or quotations.
Diffstat (limited to 'src/doc/trpl/comments.md')
-rw-r--r--src/doc/trpl/comments.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/trpl/comments.md b/src/doc/trpl/comments.md
index f02c1ad9a18..fe7acaab5fc 100644
--- a/src/doc/trpl/comments.md
+++ b/src/doc/trpl/comments.md
@@ -4,8 +4,8 @@ Now that we have some functions, it's a good idea to learn about comments.
 Comments are notes that you leave to other programmers to help explain things
 about your code. The compiler mostly ignores them.
 
-Rust has two kinds of comments that you should care about: **line comment**s
-and **doc comment**s.
+Rust has two kinds of comments that you should care about: *line comments*
+and *doc comments*.
 
 ```{rust}
 // Line comments are anything after '//' and extend to the end of the line.