From abe94f9b4d0d072e2477b989715c6c79e97de259 Mon Sep 17 00:00:00 2001 From: Huon Wilson Date: Fri, 16 Aug 2013 15:41:28 +1000 Subject: [PATCH] doc: correct spelling in documentation. --- doc/rust.md | 6 +++--- src/libextra/enum_set.rs | 2 +- src/libextra/flatpipes.rs | 2 +- src/libextra/stats.rs | 2 +- src/libstd/at_vec.rs | 2 +- src/libstd/bool.rs | 2 +- src/libstd/fmt/mod.rs | 2 +- src/libstd/fmt/parse.rs | 2 +- src/libstd/num/f32.rs | 2 +- src/libstd/ptr.rs | 2 +- src/libstd/rand.rs | 2 +- src/libstd/result.rs | 2 +- src/libstd/rt/io/mod.rs | 6 +++--- src/libstd/rt/task.rs | 3 +-- src/libstd/rt/uv/uvll.rs | 2 +- src/libstd/run.rs | 6 +++--- src/libstd/str.rs | 4 ++-- src/libstd/task/mod.rs | 6 +++--- src/libstd/to_bytes.rs | 2 +- src/libstd/unstable/atomics.rs | 6 +++--- src/libstd/unstable/finally.rs | 2 +- src/libstd/unstable/intrinsics.rs | 2 +- src/libstd/vec.rs | 4 ++-- 23 files changed, 35 insertions(+), 36 deletions(-) diff --git a/doc/rust.md b/doc/rust.md index d285253ffe2..8b06c170f03 100644 --- a/doc/rust.md +++ b/doc/rust.md @@ -582,7 +582,7 @@ a referencing source file, or by the name of the crate itself. Each source file contains a sequence of zero or more `item` definitions, and may optionally begin with any number of `attributes` that apply to the containing module. -Atributes on the anonymous crate module define important metadata that influences +Attributes on the anonymous crate module define important metadata that influences the behavior of the compiler. ~~~~~~~~ @@ -1273,7 +1273,7 @@ since the typechecker checks that any type with an implementation of `Circle` al In type-parameterized functions, methods of the supertrait may be called on values of subtrait-bound type parameters. -Refering to the previous example of `trait Circle : Shape`: +Referring to the previous example of `trait Circle : Shape`: ~~~ # trait Shape { fn area(&self) -> float; } @@ -1914,7 +1914,7 @@ A field access on a record is an [lvalue](#lvalues-rvalues-and-temporaries) refe When the field is mutable, it can be [assigned](#assignment-expressions) to. When the type of the expression to the left of the dot is a pointer to a record or structure, -it is automatically derferenced to make the field access possible. +it is automatically dereferenced to make the field access possible. ### Vector expressions diff --git a/src/libextra/enum_set.rs b/src/libextra/enum_set.rs index 28ff16c43e8..2b1246b0af0 100644 --- a/src/libextra/enum_set.rs +++ b/src/libextra/enum_set.rs @@ -18,7 +18,7 @@ pub struct EnumSet { priv bits: uint } -/// An iterface for casting C-like enum to uint and back. +/// An interface for casting C-like enum to uint and back. pub trait CLike { /// Converts C-like enum to uint. fn to_uint(&self) -> uint; diff --git a/src/libextra/flatpipes.rs b/src/libextra/flatpipes.rs index 74653828121..aa7c6433f1f 100644 --- a/src/libextra/flatpipes.rs +++ b/src/libextra/flatpipes.rs @@ -166,7 +166,7 @@ Constructors for flat pipes that send POD types using memcpy. This module is currently unsafe because it uses `Clone + Send` as a type parameter bounds meaning POD (plain old data), but `Clone + Send` and -POD are not equivelant. +POD are not equivalent. */ pub mod pod { diff --git a/src/libextra/stats.rs b/src/libextra/stats.rs index 0868c767e16..0cea4c1ac6c 100644 --- a/src/libextra/stats.rs +++ b/src/libextra/stats.rs @@ -365,7 +365,7 @@ pub fn write_boxplot(w: @io::Writer, s: &Summary, width_hint: uint) { w.write_str(histr); } -/// Returns a HashMap with the number of occurences of every element in the +/// Returns a HashMap with the number of occurrences of every element in the /// sequence that the iterator exposes. pub fn freq_count, U: Eq+Hash>(mut iter: T) -> hashmap::HashMap { let mut map = hashmap::HashMap::new::(); diff --git a/src/libstd/at_vec.rs b/src/libstd/at_vec.rs index 31de7bf82f8..120946ad161 100644 --- a/src/libstd/at_vec.rs +++ b/src/libstd/at_vec.rs @@ -200,7 +200,7 @@ pub mod raw { * Sets the length of a vector * * This will explicitly set the size of the vector, without actually - * modifing its buffers, so it is up to the caller to ensure that + * modifying its buffers, so it is up to the caller to ensure that * the vector is actually the specified size. */ #[inline] diff --git a/src/libstd/bool.rs b/src/libstd/bool.rs index 598e8080618..b8175e43fb6 100644 --- a/src/libstd/bool.rs +++ b/src/libstd/bool.rs @@ -33,7 +33,7 @@ and more. Also, a few conversion functions: `to_bit` and `to_str`. -Finally, some inquries into the nature of truth: `is_true` and `is_false`. +Finally, some inquiries into the nature of truth: `is_true` and `is_false`. */ diff --git a/src/libstd/fmt/mod.rs b/src/libstd/fmt/mod.rs index 70ec5d93199..5feb72cb9cd 100644 --- a/src/libstd/fmt/mod.rs +++ b/src/libstd/fmt/mod.rs @@ -147,7 +147,7 @@ helper methods. ## Internationalization The formatting syntax supported by the `ifmt!` extension supports -internationalization by providing "methods" which execute various differnet +internationalization by providing "methods" which execute various different outputs depending on the input. The syntax and methods provided are similar to other internationalization systems, so again nothing should seem alien. Currently two methods are supported by this extension: "select" and "plural". diff --git a/src/libstd/fmt/parse.rs b/src/libstd/fmt/parse.rs index 0d39ae84a60..84295d0bd5a 100644 --- a/src/libstd/fmt/parse.rs +++ b/src/libstd/fmt/parse.rs @@ -66,7 +66,7 @@ pub enum Position<'self> { ArgumentNext, ArgumentIs(uint), ArgumentNamed(&'self str) } -/// Enum of alignments which are supoprted. +/// Enum of alignments which are supported. #[deriving(Eq)] pub enum Alignment { AlignLeft, AlignRight, AlignUnknown } diff --git a/src/libstd/num/f32.rs b/src/libstd/num/f32.rs index faf9b2e2390..52d5f835fe6 100644 --- a/src/libstd/num/f32.rs +++ b/src/libstd/num/f32.rs @@ -125,7 +125,7 @@ pub static neg_infinity: f32 = -1.0_f32/0.0_f32; pub mod consts { // FIXME (requires Issue #1433 to fix): replace with mathematical // staticants from cmath. - /// Archimedes' staticant + /// Archimedes' constant pub static pi: f32 = 3.14159265358979323846264338327950288_f32; /// pi/2.0 diff --git a/src/libstd/ptr.rs b/src/libstd/ptr.rs index 50c25a2f722..6244189d0d6 100644 --- a/src/libstd/ptr.rs +++ b/src/libstd/ptr.rs @@ -254,7 +254,7 @@ pub unsafe fn array_each_with_len(arr: **T, len: uint, cb: &fn(*T)) { passing to the provided callback function SAFETY NOTE: This will only work with a null-terminated - pointer array. Barely less-dodgey Pointer Arithmetic. + pointer array. Barely less-dodgy Pointer Arithmetic. Dragons be here. */ pub unsafe fn array_each(arr: **T, cb: &fn(*T)) { diff --git a/src/libstd/rand.rs b/src/libstd/rand.rs index bd2ea1d6ac6..9e53c596656 100644 --- a/src/libstd/rand.rs +++ b/src/libstd/rand.rs @@ -658,7 +658,7 @@ pub fn rng() -> IsaacRng { /// Create a weak random number generator with a default algorithm and seed. /// -/// It returns the fatest `Rng` algorithm currently available in Rust without +/// It returns the fastest `Rng` algorithm currently available in Rust without /// consideration for cryptography or security. If you require a specifically /// seeded `Rng` for consistency over time you should pick one algorithm and /// create the `Rng` yourself. diff --git a/src/libstd/result.rs b/src/libstd/result.rs index 9de5e69148a..61cf8df4a1f 100644 --- a/src/libstd/result.rs +++ b/src/libstd/result.rs @@ -25,7 +25,7 @@ use str::StrSlice; /// `Result` is a type that represents either success (`Ok`) or failure (`Err`). /// -/// In order to provide informative error messages, `E` is reqired to implement `ToStr`. +/// In order to provide informative error messages, `E` is required to implement `ToStr`. /// It is further recommended for `E` to be a descriptive error type, eg a `enum` for /// all possible errors cases. #[deriving(Clone, Eq)] diff --git a/src/libstd/rt/io/mod.rs b/src/libstd/rt/io/mod.rs index c980dc9d73e..78c4cec2d4c 100644 --- a/src/libstd/rt/io/mod.rs +++ b/src/libstd/rt/io/mod.rs @@ -93,7 +93,7 @@ Asynchronous interfaces are most often associated with the callback (continuation-passing) style popularised by node.js. Such systems rely on all computations being run inside an event loop which maintains a list of all pending I/O events; when one completes the registered -callback is run and the code that made the I/O request continiues. +callback is run and the code that made the I/O request continues. Such interfaces achieve non-blocking at the expense of being more difficult to reason about. @@ -136,7 +136,7 @@ Rust's I/O employs a combination of techniques to reduce boilerplate while still providing feedback about errors. The basic strategy: * Errors are fatal by default, resulting in task failure -* Errors raise the `io_error` conditon which provides an opportunity to inspect +* Errors raise the `io_error` condition which provides an opportunity to inspect an IoError object containing details. * Return values must have a sensible null or zero value which is returned if a condition is handled successfully. This may be an `Option`, an empty @@ -189,7 +189,7 @@ will start passing around null or zero objects when wrapped in a condition handl * XXX: How should we use condition handlers that return values? * XXX: Should EOF raise default conditions when EOF is not an error? -# Issues withi/o scheduler affinity, work stealing, task pinning +# Issues with i/o scheduler affinity, work stealing, task pinning # Resource management diff --git a/src/libstd/rt/task.rs b/src/libstd/rt/task.rs index 708166518bb..01a8882e4f9 100644 --- a/src/libstd/rt/task.rs +++ b/src/libstd/rt/task.rs @@ -69,7 +69,7 @@ pub struct Coroutine { saved_context: Context } -/// Some tasks have a deciated home scheduler that they must run on. +/// Some tasks have a dedicated home scheduler that they must run on. pub enum SchedHome { AnySched, Sched(SchedHandle) @@ -592,4 +592,3 @@ mod test { } } } - diff --git a/src/libstd/rt/uv/uvll.rs b/src/libstd/rt/uv/uvll.rs index e240395a495..d892fc8024f 100644 --- a/src/libstd/rt/uv/uvll.rs +++ b/src/libstd/rt/uv/uvll.rs @@ -23,7 +23,7 @@ * There are also a collection of helper functions to ease interacting * with the low-level API. * - * As new functionality, existant in uv.h, is added to the rust stdlib, + * As new functionality, existent in uv.h, is added to the rust stdlib, * the mappings should be added in this module. */ diff --git a/src/libstd/run.rs b/src/libstd/run.rs index 31e317604c7..d10d9fc2854 100644 --- a/src/libstd/run.rs +++ b/src/libstd/run.rs @@ -90,7 +90,7 @@ pub struct ProcessOptions<'self> { in_fd: Option, /** - * If this is None then a new pipe will be created for the new progam's + * If this is None then a new pipe will be created for the new program's * output and Process.output() will provide a Reader to read from this pipe. * * If this is Some(file-descriptor) then the new process will write its output @@ -100,7 +100,7 @@ pub struct ProcessOptions<'self> { out_fd: Option, /** - * If this is None then a new pipe will be created for the new progam's + * If this is None then a new pipe will be created for the new program's * error stream and Process.error() will provide a Reader to read from this pipe. * * If this is Some(file-descriptor) then the new process will write its error output @@ -840,7 +840,7 @@ pub fn process_output(prog: &str, args: &[~str]) -> ProcessOutput { * Note that this is private to avoid race conditions on unix where if * a user calls waitpid(some_process.get_id()) then some_process.finish() * and some_process.destroy() and some_process.finalize() will then either - * operate on a none-existant process or, even worse, on a newer process + * operate on a none-existent process or, even worse, on a newer process * with the same id. */ fn waitpid(pid: pid_t) -> int { diff --git a/src/libstd/str.rs b/src/libstd/str.rs index a759b8cbd62..98bf963be9a 100644 --- a/src/libstd/str.rs +++ b/src/libstd/str.rs @@ -382,7 +382,7 @@ impl<'self, Sep: CharEq> Iterator<&'self str> for CharSplitIterator<'self, Sep> } } -/// An iterator over the start and end indicies of the matches of a +/// An iterator over the start and end indices of the matches of a /// substring within a larger string #[deriving(Clone)] pub struct MatchesIndexIterator<'self> { @@ -893,7 +893,7 @@ pub mod raw { /// Sets the length of a string /// /// This will explicitly set the size of the string, without actually - /// modifing its buffers, so it is up to the caller to ensure that + /// modifying its buffers, so it is up to the caller to ensure that /// the string is actually the specified size. #[inline] pub unsafe fn set_len(s: &mut ~str, new_len: uint) { diff --git a/src/libstd/task/mod.rs b/src/libstd/task/mod.rs index c38e6f23313..820baec6a79 100644 --- a/src/libstd/task/mod.rs +++ b/src/libstd/task/mod.rs @@ -365,7 +365,7 @@ impl TaskBuilder { spawn::spawn_raw(opts, f); } - /// Runs a task, while transfering ownership of one argument to the child. + /// Runs a task, while transferring ownership of one argument to the child. pub fn spawn_with(&mut self, arg: A, f: ~fn(v: A)) { let arg = Cell::new(arg); do self.spawn { @@ -474,10 +474,10 @@ pub fn spawn_indestructible(f: ~fn()) { pub fn spawn_with(arg: A, f: ~fn(v: A)) { /*! - * Runs a task, while transfering ownership of one argument to the + * Runs a task, while transferring ownership of one argument to the * child. * - * This is useful for transfering ownership of noncopyables to + * This is useful for transferring ownership of noncopyables to * another task. * * This function is equivalent to `task().spawn_with(arg, f)`. diff --git a/src/libstd/to_bytes.rs b/src/libstd/to_bytes.rs index f871f4ef6d6..4d84b6d251d 100644 --- a/src/libstd/to_bytes.rs +++ b/src/libstd/to_bytes.rs @@ -28,7 +28,7 @@ pub type Cb<'self> = &'self fn(buf: &[u8]) -> bool; * A trait to implement in order to make a type hashable; * This works in combination with the trait `Hash::Hash`, and * may in the future be merged with that trait or otherwise - * modified when default methods and trait inheritence are + * modified when default methods and trait inheritance are * completed. */ pub trait IterBytes { diff --git a/src/libstd/unstable/atomics.rs b/src/libstd/unstable/atomics.rs index 2cfe63d9926..f286235ca0e 100644 --- a/src/libstd/unstable/atomics.rs +++ b/src/libstd/unstable/atomics.rs @@ -39,14 +39,14 @@ pub struct AtomicBool { } /** - * A signed atomic integer type, supporting basic atomic aritmetic operations + * A signed atomic integer type, supporting basic atomic arithmetic operations */ pub struct AtomicInt { priv v: int } /** - * An unsigned atomic integer type, supporting basic atomic aritmetic operations + * An unsigned atomic integer type, supporting basic atomic arithmetic operations */ pub struct AtomicUint { priv v: uint @@ -497,7 +497,7 @@ pub unsafe fn atomic_xor(dst: &mut T, val: T, order: Ordering) -> T { * A fence 'A' which has `Release` ordering semantics, synchronizes with a * fence 'B' with (at least) `Acquire` semantics, if and only if there exists * atomic operations X and Y, both operating on some atomic object 'M' such - * that A is sequenced before X, Y is synchronized before B and Y obsevers + * that A is sequenced before X, Y is synchronized before B and Y observers * the change to M. This provides a happens-before dependence between A and B. * * Atomic operations with `Release` or `Acquire` semantics can also synchronize diff --git a/src/libstd/unstable/finally.rs b/src/libstd/unstable/finally.rs index 10db664450e..7fbe9179f75 100644 --- a/src/libstd/unstable/finally.rs +++ b/src/libstd/unstable/finally.rs @@ -18,7 +18,7 @@ stack closures that emulates Java-style try/finally blocks. do || { ... }.finally { - alway_run_this(); + always_run_this(); } ~~~ */ diff --git a/src/libstd/unstable/intrinsics.rs b/src/libstd/unstable/intrinsics.rs index 861b4f9a350..0642bb19737 100644 --- a/src/libstd/unstable/intrinsics.rs +++ b/src/libstd/unstable/intrinsics.rs @@ -22,7 +22,7 @@ semantics as C++11. See the LLVM documentation on [[atomics]]. A quick refresher on memory ordering: -* Acquire - a barrier for aquiring a lock. Subsequent reads and writes +* Acquire - a barrier for acquiring a lock. Subsequent reads and writes take place after the barrier. * Release - a barrier for releasing a lock. Preceding reads and writes take place before the barrier. diff --git a/src/libstd/vec.rs b/src/libstd/vec.rs index 7748c040a1d..7c8046a64b2 100644 --- a/src/libstd/vec.rs +++ b/src/libstd/vec.rs @@ -468,7 +468,7 @@ impl<'self, T> Iterator<&'self [T]> for WindowIter<'self, T> { /// elements at a time). /// /// When the vector len is not evenly divided by the chunk size, -/// the last slice of the iteration will be the remainer. +/// the last slice of the iteration will be the remainder. #[deriving(Clone)] pub struct ChunkIter<'self, T> { priv v: &'self [T], @@ -1930,7 +1930,7 @@ pub mod raw { * Sets the length of a vector * * This will explicitly set the size of the vector, without actually - * modifing its buffers, so it is up to the caller to ensure that + * modifying its buffers, so it is up to the caller to ensure that * the vector is actually the specified size. */ #[inline]