diff options
| author | bors <bors@rust-lang.org> | 2014-11-14 18:17:28 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2014-11-14 18:17:28 +0000 |
| commit | 1e4e55aebc1a71b6674c00b8604efa6b1e2e52cd (patch) | |
| tree | d57cb32a69c139630345db9c9a52fda4bf900b6c /src/libsync | |
| parent | 1bf06495443584539b958873e04cc2f864ab10e4 (diff) | |
| parent | 5969bf663ef6ea4c62d27b88a957d401dad4227b (diff) | |
| download | rust-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/libsync')
| -rw-r--r-- | src/libsync/comm/mod.rs | 2 | ||||
| -rw-r--r-- | src/libsync/lock.rs | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/src/libsync/comm/mod.rs b/src/libsync/comm/mod.rs index 247f50d666e..65b3e30c2b9 100644 --- a/src/libsync/comm/mod.rs +++ b/src/libsync/comm/mod.rs @@ -43,7 +43,7 @@ //! "rendezvous" channel where each sender atomically hands off a message to //! a receiver. //! -//! ## Failure Propagation +//! ## Panic Propagation //! //! In addition to being a core primitive for communicating in rust, channels //! are the points at which panics are propagated among tasks. Whenever the one diff --git a/src/libsync/lock.rs b/src/libsync/lock.rs index a9b0b7c4803..0ef3e77da00 100644 --- a/src/libsync/lock.rs +++ b/src/libsync/lock.rs @@ -345,9 +345,9 @@ impl<T: Send + Sync> RWLock<T> { /// Access the underlying data immutably. May run concurrently with other /// reading tasks. /// - /// # Failure + /// # Panics /// - /// Failing will unlock the lock while unwinding. However, unlike all other + /// Panicking will unlock the lock while unwinding. However, unlike all other /// access modes, this will not poison the lock. pub fn read<'a>(&'a self) -> RWLockReadGuard<'a, T> { let guard = self.lock.read(); |
