about summary refs log tree commit diff
path: root/src/doc/trpl
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-05-19 18:38:54 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-05-19 18:38:54 -0400
commit7f742129068f44fbf3cf1cab2f2d1d28e54ac845 (patch)
tree75347f841dabcf941481895f90a16751d5b89139 /src/doc/trpl
parent1d961fde2de02b6f30bd97354badec630975fed6 (diff)
parentafbe15d103dd12e177b7fa875b8c21d43e2f15a3 (diff)
downloadrust-7f742129068f44fbf3cf1cab2f2d1d28e54ac845.tar.gz
rust-7f742129068f44fbf3cf1cab2f2d1d28e54ac845.zip
Rollup merge of #25607 - peferron:doc-macros-assert-fix, r=steveklabnik
"Truth passes, success `panic!`s" seems to be a typo. The closest fix would be something like "Success passes, failure `panic!`s" but to me a "comparison failure" suggests that we couldn't compare the two values at all, not that we could successfully compare them and that the result was non-equality. So I opted to rewrite the paragraph a bit. If there's a better alternative please let me know.

r? @steveklabnik 
Diffstat (limited to 'src/doc/trpl')
-rw-r--r--src/doc/trpl/macros.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/doc/trpl/macros.md b/src/doc/trpl/macros.md
index ce06987013d..cc7d9b595f9 100644
--- a/src/doc/trpl/macros.md
+++ b/src/doc/trpl/macros.md
@@ -683,9 +683,9 @@ let v = vec![0; 100];
 
 ## assert! and assert_eq!
 
-These two macros are used in tests. `assert!` takes a boolean, and `assert_eq!`
-takes two values and compares them. Truth passes, success `panic!`s. Like
-this:
+These two macros are used in tests. `assert!` takes a boolean. `assert_eq!`
+takes two values and checks them for equality. `true` passes, `false` `panic!`s.
+Like this:
 
 ```rust,no_run
 // A-ok!