about summary refs log tree commit diff
path: root/src/libstd/num
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2014-11-14 18:17:28 +0000
committerbors <bors@rust-lang.org>2014-11-14 18:17:28 +0000
commit1e4e55aebc1a71b6674c00b8604efa6b1e2e52cd (patch)
treed57cb32a69c139630345db9c9a52fda4bf900b6c /src/libstd/num
parent1bf06495443584539b958873e04cc2f864ab10e4 (diff)
parent5969bf663ef6ea4c62d27b88a957d401dad4227b (diff)
downloadrust-1e4e55aebc1a71b6674c00b8604efa6b1e2e52cd.tar.gz
rust-1e4e55aebc1a71b6674c00b8604efa6b1e2e52cd.zip
auto merge of #18880 : barosl/rust/doc-fail-to-panic, r=alexcrichton
I found some occurrences of "failure" and "fails" in the documentation. I changed them to "panics" if it means a task panic. Otherwise I left it as is, or changed it to "errors" to clearly distinguish them.

Also, I made a minor fix that is breaking the layout of a module page. "Example" is shown in an irrelevant place from the following page: http://doc.rust-lang.org/std/os/index.html
Diffstat (limited to 'src/libstd/num')
-rw-r--r--src/libstd/num/strconv.rs12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/libstd/num/strconv.rs b/src/libstd/num/strconv.rs
index 06d2f0ef028..fff31b332e1 100644
--- a/src/libstd/num/strconv.rs
+++ b/src/libstd/num/strconv.rs
@@ -88,8 +88,8 @@ pub enum SignFormat {
  * It returns a tuple because there can be ambiguity between a special value
  * and a number representation at higher bases.
  *
- * # Failure
- * - Fails if `radix` < 2 or `radix` > 36.
+ * # Panics
+ * - Panics if `radix` < 2 or `radix` > 36.
  */
 fn int_to_str_bytes_common<T: Int>(num: T, radix: uint, sign: SignFormat, f: |u8|) {
     assert!(2 <= radix && radix <= 36);
@@ -172,11 +172,11 @@ fn int_to_str_bytes_common<T: Int>(num: T, radix: uint, sign: SignFormat, f: |u8
  * It returns a tuple because there can be ambiguity between a special value
  * and a number representation at higher bases.
  *
- * # Failure
- * - Fails if `radix` < 2 or `radix` > 36.
- * - Fails if `radix` > 14 and `exp_format` is `ExpDec` due to conflict
+ * # Panics
+ * - Panics if `radix` < 2 or `radix` > 36.
+ * - Panics if `radix` > 14 and `exp_format` is `ExpDec` due to conflict
  *   between digit and exponent sign `'e'`.
- * - Fails if `radix` > 25 and `exp_format` is `ExpBin` due to conflict
+ * - Panics if `radix` > 25 and `exp_format` is `ExpBin` due to conflict
  *   between digit and exponent sign `'p'`.
  */
 pub fn float_to_str_bytes_common<T: Float>(