Skip to content

Commit

Permalink
Spellcheck library docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
huonw committed Feb 17, 2014
1 parent c848906 commit 6555b04
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 15 deletions.
10 changes: 5 additions & 5 deletions src/libextra/json.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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());
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/libextra/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
Expand Down
2 changes: 1 addition & 1 deletion src/libgreen/sched.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/comm/select.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1287,7 +1287,7 @@ pub trait Acceptor<T> {
///
/// 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,
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/iter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -883,7 +883,7 @@ pub trait OrdIterator<A> {
/// ```
fn min(&mut self) -> Option<A>;

/// `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.
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/rt/task.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/rt/unwind.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
3 changes: 1 addition & 2 deletions src/libstd/sync/mpsc_queue.rs
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ impl<T: Send> Queue<T> {
///
/// Note that the current implementation means that this function cannot
/// return `Option<T>`. 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.
///
Expand Down Expand Up @@ -203,4 +203,3 @@ mod tests {
}
}
}

2 changes: 1 addition & 1 deletion src/libsync/sync/mutex.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

5 comments on commit 6555b04

@bors
Copy link
Contributor

@bors bors commented on 6555b04 Feb 18, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from cmr
at huonw@6555b04

@bors
Copy link
Contributor

@bors bors commented on 6555b04 Feb 18, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging huonw/rust/speeling = 6555b04 into auto

@bors
Copy link
Contributor

@bors bors commented on 6555b04 Feb 18, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

huonw/rust/speeling = 6555b04 merged ok, testing candidate = b3ed38f

@bors
Copy link
Contributor

@bors bors commented on 6555b04 Feb 18, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bors
Copy link
Contributor

@bors bors commented on 6555b04 Feb 18, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = b3ed38f

Please sign in to comment.