From 6555b04dd2fbcd18c8fa8beb2bebc4b81febc6b0 Mon Sep 17 00:00:00 2001 From: Huon Wilson Date: Mon, 17 Feb 2014 22:53:45 +1100 Subject: [PATCH] Spellcheck library docs. --- src/libextra/json.rs | 10 +++++----- src/libextra/test.rs | 2 +- src/libgreen/sched.rs | 2 +- src/libstd/comm/select.rs | 2 +- src/libstd/io/mod.rs | 2 +- src/libstd/iter.rs | 2 +- src/libstd/rt/task.rs | 2 +- src/libstd/rt/unwind.rs | 2 +- src/libstd/sync/mpsc_queue.rs | 3 +-- src/libsync/sync/mutex.rs | 2 +- 10 files changed, 14 insertions(+), 15 deletions(-) diff --git a/src/libextra/json.rs b/src/libextra/json.rs index 4c6cd4218e7..edf5bb63b30 100644 --- a/src/libextra/json.rs +++ b/src/libextra/json.rs @@ -125,7 +125,7 @@ fn main() { } ``` -To decode a json string using `Decodable` trait : +To decode a JSON string using `Decodable` trait : ```rust extern crate serialize; @@ -172,7 +172,7 @@ fn main() { {data_int: 1, data_str:~"toto", data_vector:~[2,3,4,5]}; let encoded_str: ~str = json::Encoder::str_encode(&to_encode_object); - // To unserialize use the `extra::json::from_str` and `extra::json::Decoder` + // To deserialize use the `extra::json::from_str` and `extra::json::Decoder` let json_object = extra::json::from_str(encoded_str); let mut decoder = json::Decoder::new(json_object.unwrap()); @@ -182,7 +182,7 @@ fn main() { ## Using `ToJson` -This example use the ToJson impl to unserialize the json string. +This example use the ToJson impl to deserialize the JSON string. Example of `ToJson` trait implementation for TestStruct1. ```rust @@ -212,13 +212,13 @@ impl ToJson for TestStruct1 { } fn main() { - // Seralization using our impl of to_json + // Serialization using our impl of to_json let test2: TestStruct1 = TestStruct1 {data_int: 1, data_str:~"toto", data_vector:~[2,3,4,5]}; let tjson: json::Json = test2.to_json(); let json_str: ~str = tjson.to_str(); - // Unserialize like before. + // Deserialize like before. let mut decoder = json::Decoder::new(json::from_str(json_str).unwrap()); // create the final object diff --git a/src/libextra/test.rs b/src/libextra/test.rs index 07327227d85..3ee2cf6371a 100644 --- a/src/libextra/test.rs +++ b/src/libextra/test.rs @@ -1111,7 +1111,7 @@ impl MetricMap { // Benchmarking -/// A function that is opaque to the optimiser, to allow benchmarks to +/// A function that is opaque to the optimizer, to allow benchmarks to /// pretend to use outputs to assist in avoiding dead-code /// elimination. /// diff --git a/src/libgreen/sched.rs b/src/libgreen/sched.rs index ad32ba7ba6d..a966dff000a 100644 --- a/src/libgreen/sched.rs +++ b/src/libgreen/sched.rs @@ -86,7 +86,7 @@ pub struct Scheduler { /// A flag to tell the scheduler loop it needs to do some stealing /// in order to introduce randomness as part of a yield steal_for_yield: bool, - /// Bookeeping for the number of tasks which are currently running around + /// Bookkeeping for the number of tasks which are currently running around /// inside this pool of schedulers task_state: TaskState, diff --git a/src/libstd/comm/select.rs b/src/libstd/comm/select.rs index e41fa60aa42..02066086ad7 100644 --- a/src/libstd/comm/select.rs +++ b/src/libstd/comm/select.rs @@ -144,7 +144,7 @@ impl Select { } } - /// Waits for an event on this port set. The returned valus is *not* and + /// Waits for an event on this port set. The returned value is *not* an /// index, but rather an id. This id can be queried against any active /// `Handle` structures (each one has an `id` method). The handle with /// the matching `id` will have some sort of event available on it. The diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index c99fe587fc0..2eadf9a7f4f 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -1287,7 +1287,7 @@ pub trait Acceptor { /// /// Since connection attempts can continue forever, this iterator always returns /// `Some`. The `Some` contains the `IoResult` representing whether the -/// connection attempt was succesful. A successful connection will be wrapped +/// connection attempt was successful. A successful connection will be wrapped /// in `Ok`. A failed connection is represented as an `Err`. pub struct IncomingConnections<'a, A> { priv inc: &'a mut A, diff --git a/src/libstd/iter.rs b/src/libstd/iter.rs index e5a89fc42e1..7516a3ddf54 100644 --- a/src/libstd/iter.rs +++ b/src/libstd/iter.rs @@ -883,7 +883,7 @@ pub trait OrdIterator { /// ``` fn min(&mut self) -> Option; - /// `min_max` finds the mininum and maximum elements in the iterator. + /// `min_max` finds the minimum and maximum elements in the iterator. /// /// The return type `MinMaxResult` is an enum of three variants: /// - `NoElements` if the iterator is empty. diff --git a/src/libstd/rt/task.rs b/src/libstd/rt/task.rs index 0719523af77..72ba98eab4f 100644 --- a/src/libstd/rt/task.rs +++ b/src/libstd/rt/task.rs @@ -254,7 +254,7 @@ impl Task { ops.deschedule(amt, self, f) } - /// Wakes up a previously blocked task, optionally specifiying whether the + /// Wakes up a previously blocked task, optionally specifying whether the /// current task can accept a change in scheduling. This function can only /// be called on tasks that were previously blocked in `deschedule`. pub fn reawaken(mut ~self) { diff --git a/src/libstd/rt/unwind.rs b/src/libstd/rt/unwind.rs index 5718a27bfef..ef8bd94c897 100644 --- a/src/libstd/rt/unwind.rs +++ b/src/libstd/rt/unwind.rs @@ -400,7 +400,7 @@ pub fn begin_unwind_raw(msg: *u8, file: *u8, line: uint) -> ! { /// The entry point for unwinding with a formatted message. /// /// This is designed to reduce the amount of code required at the call -/// site as much as possible (so that `fail!()` has as low an implact +/// site as much as possible (so that `fail!()` has as low an impact /// on (e.g.) the inlining of other functions as possible), by moving /// the actual formatting into this shared place. #[inline(never)] #[cold] diff --git a/src/libstd/sync/mpsc_queue.rs b/src/libstd/sync/mpsc_queue.rs index b5a55f3f8c9..2dc63380cb8 100644 --- a/src/libstd/sync/mpsc_queue.rs +++ b/src/libstd/sync/mpsc_queue.rs @@ -104,7 +104,7 @@ impl Queue { /// /// Note that the current implementation means that this function cannot /// return `Option`. It is possible for this queue to be in an - /// inconsistent state where many pushes have suceeded and completely + /// inconsistent state where many pushes have succeeded and completely /// finished, but pops cannot return `Some(t)`. This inconsistent state /// happens when a pusher is pre-empted at an inopportune moment. /// @@ -203,4 +203,3 @@ mod tests { } } } - diff --git a/src/libsync/sync/mutex.rs b/src/libsync/sync/mutex.rs index 9ca2f1fd7ff..923f12ed1d1 100644 --- a/src/libsync/sync/mutex.rs +++ b/src/libsync/sync/mutex.rs @@ -460,7 +460,7 @@ impl Mutex { /// Acquires a mutex, blocking the current task until it is able to do so. /// - /// This function will block the local task until it is availble to acquire + /// This function will block the local task until it is available to acquire /// the mutex. Upon returning, the task is the only task with the mutex /// held. An RAII guard is returned to allow scoped unlock of the lock. When /// the guard goes out of scope, the mutex will be unlocked.