about summary refs log tree commit diff
path: root/src/libstd/io
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/io
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/io')
-rw-r--r--src/libstd/io/mod.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 9828c2092d3..64fed1a5442 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -914,9 +914,9 @@ impl<'a> Reader for &'a mut Reader+'a {
 /// Similar to `slice()` except this function only bounds the slice on the
 /// capacity of `v`, not the length.
 ///
-/// # Failure
+/// # Panics
 ///
-/// Fails when `start` or `end` point outside the capacity of `v`, or when
+/// Panics when `start` or `end` point outside the capacity of `v`, or when
 /// `start` > `end`.
 // Private function here because we aren't sure if we want to expose this as
 // API yet. If so, it should be a method on Vec.