Skip to content

Commit

Permalink
Fix all code examples
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcrichton committed Feb 15, 2014
1 parent 6667f90 commit e72ddbd
Show file tree
Hide file tree
Showing 18 changed files with 103 additions and 67 deletions.
2 changes: 1 addition & 1 deletion src/libextra/json.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ An object is a series of string keys mapping to values, in `"key": value` format
Arrays are enclosed in square brackets ([ ... ]) and objects in curly brackets ({ ... }).
A simple JSON document encoding a person, his/her age, address and phone numbers could look like:
```
```ignore
{
"FirstName": "John",
"LastName": "Doe",
Expand Down
2 changes: 1 addition & 1 deletion src/libextra/stats.rs
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ pub fn write_5_number_summary(w: &mut io::Writer,
/// As an example, the summary with 5-number-summary `(min=15, q1=17, med=20, q3=24, max=31)` might
/// display as:
///
/// ~~~~
/// ~~~~ignore
/// 10 | [--****#******----------] | 40
/// ~~~~

Expand Down
2 changes: 1 addition & 1 deletion src/libglob/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ pub struct Paths {
///
/// The above code will print:
///
/// ```
/// ```ignore
/// /media/pictures/kittens.jpg
/// /media/pictures/puppies.jpg
/// ```
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/comm/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
//! let (port, chan) = Chan::new();
//! spawn(proc() {
//! chan.send(10);
//! })
//! });
//! assert_eq!(port.recv(), 10);
//!
//! // Create a shared channel which can be sent along from many tasks
Expand Down
12 changes: 6 additions & 6 deletions src/libstd/fmt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ function, but the `format!` macro is a syntax extension which allows it to
leverage named parameters. Named parameters are listed at the end of the
argument list and have the syntax:
```
```ignore
identifier '=' expression
```
Expand All @@ -107,7 +107,7 @@ and if all references to one argument do not provide a type, then the format `?`
is used (the type's rust-representation is printed). For example, this is an
invalid format string:
```
```ignore
{0:d} {0:s}
```
Expand All @@ -123,7 +123,7 @@ must have the type `uint`. Although a `uint` can be printed with `{:u}`, it is
illegal to reference an argument as such. For example, this is another invalid
format string:
```
```ignore
{:.*s} {0:u}
```
Expand Down Expand Up @@ -334,7 +334,7 @@ This example is the equivalent of `{0:s}` essentially.
The select method is a switch over a `&str` parameter, and the parameter *must*
be of the type `&str`. An example of the syntax is:
```
```ignore
{0, select, male{...} female{...} other{...}}
```
Expand All @@ -353,7 +353,7 @@ The plural method is a switch statement over a `uint` parameter, and the
parameter *must* be a `uint`. A plural method in its full glory can be specified
as:
```
```ignore
{0, plural, offset=1 =1{...} two{...} many{...} other{...}}
```
Expand Down Expand Up @@ -381,7 +381,7 @@ should not be too alien. Arguments are formatted with python-like syntax,
meaning that arguments are surrounded by `{}` instead of the C-like `%`. The
actual grammar for the formatting syntax is:
```
```ignore
format_string := <text> [ format <text> ] *
format := '{' [ argument ] [ ':' format_spec ] [ ',' function_spec ] '}'
argument := integer | identifier
Expand Down
17 changes: 13 additions & 4 deletions src/libstd/io/comm_adapters.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,16 @@ use vec::{bytes, CloneableVector, MutableVector, ImmutableVector};
/// # Example
///
/// ```
/// let reader = PortReader::new(port);
/// use std::io::PortReader;
///
/// let (port, chan) = Chan::new();
/// # drop(chan);
/// let mut reader = PortReader::new(port);
///
/// let mut buf = ~[0u8, ..100];
/// match reader.read(buf) {
/// Some(nread) => println!("Read {} bytes", nread),
/// None => println!("At the end of the stream!")
/// Ok(nread) => println!("Read {} bytes", nread),
/// Err(e) => println!("read error: {}", e),
/// }
/// ```
pub struct PortReader {
Expand Down Expand Up @@ -83,7 +87,12 @@ impl Reader for PortReader {
/// # Example
///
/// ```
/// let writer = ChanWriter::new(chan);
/// # #[allow(unused_must_use)];
/// use std::io::ChanWriter;
///
/// let (port, chan) = Chan::new();
/// # drop(port);
/// let mut writer = ChanWriter::new(chan);
/// writer.write("hello, world".as_bytes());
/// ```
pub struct ChanWriter {
Expand Down
13 changes: 8 additions & 5 deletions src/libstd/io/net/unix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,18 @@ impl UnixListener {
/// # Example
///
/// ```
/// # fn main() {}
/// # fn foo() {
/// # #[allow(unused_must_use)];
/// use std::io::net::unix::UnixListener;
/// use std::io::Listener;
/// use std::io::{Listener, Acceptor};
///
/// let server = Path::new("path/to/my/socket");
/// let mut stream = UnixListener::bind(&server);
/// for client in stream.incoming() {
/// let mut client = client;
/// let server = Path::new("/path/to/my/socket");
/// let stream = UnixListener::bind(&server);
/// for mut client in stream.listen().incoming() {
/// client.write([1, 2, 3, 4]);
/// }
/// # }
/// ```
pub fn bind<P: ToCStr>(path: &P) -> IoResult<UnixListener> {
LocalIo::maybe_raise(|io| {
Expand Down
9 changes: 7 additions & 2 deletions src/libstd/kinds.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ pub mod marker {
/// Given a struct `S` that includes a type parameter `T`
/// but does not actually *reference* that type parameter:
///
/// ```
/// ```ignore
/// use std::cast;
///
/// struct S<T> { x: *() }
/// fn get<T>(s: &S<T>) -> T {
/// unsafe {
Expand Down Expand Up @@ -109,6 +111,8 @@ pub mod marker {
/// but does not actually *reference* that type parameter:
///
/// ```
/// use std::cast;
///
/// struct S<T> { x: *() }
/// fn get<T>(s: &S<T>, v: T) {
/// unsafe {
Expand Down Expand Up @@ -147,7 +151,8 @@ pub mod marker {
/// "interior" mutability:
///
/// ```
/// struct Cell<T> { priv value: T }
/// pub struct Cell<T> { priv value: T }
/// # fn main() {}
/// ```
///
/// The type system would infer that `value` is only read here and
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/logging.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ disabled except for `error!` (a log level of 1). Logging is controlled via the
`RUST_LOG` environment variable. The value of this environment variable is a
comma-separated list of logging directives. A logging directive is of the form:
```
```ignore
path::to::module=log_level
```
Expand All @@ -65,7 +65,7 @@ all modules is set to this value.
Some examples of valid values of `RUST_LOG` are:
```
```ignore
hello // turns on all logging for the 'hello' module
info // turns on all info logging
hello=debug // turns on debug logging for 'hello'
Expand Down
41 changes: 22 additions & 19 deletions src/libstd/num/int_macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ impl Rem<$T,$T> for $T {
/// Returns the integer remainder after division, satisfying:
///
/// ```
/// # let n = 1;
/// # let d = 2;
/// assert!((n / d) * d + (n % d) == n)
/// ```
///
Expand Down Expand Up @@ -194,15 +196,15 @@ impl Integer for $T {
/// # Examples
///
/// ```
/// assert!(( 8).div_floor( 3) == 2);
/// assert!(( 8).div_floor(-3) == -3);
/// assert!((-8).div_floor( 3) == -3);
/// assert!((-8).div_floor(-3) == 2);
///
/// assert!(( 1).div_floor( 2) == 0);
/// assert!(( 1).div_floor(-2) == -1);
/// assert!((-1).div_floor( 2) == -1);
/// assert!((-1).div_floor(-2) == 0);
/// assert!(( 8i).div_floor(& 3) == 2);
/// assert!(( 8i).div_floor(&-3) == -3);
/// assert!((-8i).div_floor(& 3) == -3);
/// assert!((-8i).div_floor(&-3) == 2);
///
/// assert!(( 1i).div_floor(& 2) == 0);
/// assert!(( 1i).div_floor(&-2) == -1);
/// assert!((-1i).div_floor(& 2) == -1);
/// assert!((-1i).div_floor(&-2) == 0);
/// ```
///
#[inline]
Expand All @@ -220,21 +222,22 @@ impl Integer for $T {
/// Integer modulo, satisfying:
///
/// ```
/// assert!(n.div_floor(d) * d + n.mod_floor(d) == n)
/// # let n = 1i; let d = 1i;
/// assert!(n.div_floor(&d) * d + n.mod_floor(&d) == n)
/// ```
///
/// # Examples
///
/// ```
/// assert!(( 8).mod_floor( 3) == 2);
/// assert!(( 8).mod_floor(-3) == -1);
/// assert!((-8).mod_floor( 3) == 1);
/// assert!((-8).mod_floor(-3) == -2);
///
/// assert!(( 1).mod_floor( 2) == 1);
/// assert!(( 1).mod_floor(-2) == -1);
/// assert!((-1).mod_floor( 2) == 1);
/// assert!((-1).mod_floor(-2) == -1);
/// assert!(( 8i).mod_floor(& 3) == 2);
/// assert!(( 8i).mod_floor(&-3) == -1);
/// assert!((-8i).mod_floor(& 3) == 1);
/// assert!((-8i).mod_floor(&-3) == -2);
///
/// assert!(( 1i).mod_floor(& 2) == 1);
/// assert!(( 1i).mod_floor(&-2) == -1);
/// assert!((-1i).mod_floor(& 2) == 1);
/// assert!((-1i).mod_floor(&-2) == -1);
/// ```
///
#[inline]
Expand Down
6 changes: 4 additions & 2 deletions src/libstd/num/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pub trait Zero: Add<Self, Self> {
///
/// # Laws
///
/// ~~~
/// ~~~ignore
/// a + 0 = a ∀ a ∈ Self
/// 0 + a = a ∀ a ∈ Self
/// ~~~
Expand All @@ -71,7 +71,7 @@ pub trait One: Mul<Self, Self> {
///
/// # Laws
///
/// ~~~
/// ~~~ignore
/// a * 1 = a ∀ a ∈ Self
/// 1 * a = a ∀ a ∈ Self
/// ~~~
Expand Down Expand Up @@ -964,6 +964,8 @@ impl_from_primitive!(f64, n.to_f64())
/// # Example
///
/// ```
/// use std::num;
///
/// let twenty: f32 = num::cast(0x14).unwrap();
/// assert_eq!(twenty, 20f32);
/// ```
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/rand/distributions/gamma.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use super::{IndependentSample, Sample, Exp};
///
/// The density function of this distribution is
///
/// ```
/// ```ignore
/// f(x) = x^(k - 1) * exp(-x / θ) / (Γ(k) * θ^k)
/// ```
///
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2011,7 +2011,7 @@ pub trait StrSlice<'a> {
///
/// ## Output
///
/// ```
/// ```ignore
/// 0: 中
/// 3: 华
/// 6: V
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/task.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
*
* ```
* spawn(proc() {
* log(error, "Hello, World!");
* println!("Hello, World!");
* })
* ```
*/
Expand Down
14 changes: 10 additions & 4 deletions src/libstd/unstable/finally.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,16 @@ also be used. See that function for more details.
# Example
```
```
use std::unstable::finally::Finally;
# fn always_run_this() {}
(|| {
...
// ...
}).finally(|| {
always_run_this();
})
```
```
*/

use ops::Drop;
Expand Down Expand Up @@ -69,13 +72,16 @@ impl<T> Finally<T> for fn() -> T {
* # Example
*
* ```
* use std::unstable::finally::try_finally;
*
* struct State<'a> { buffer: &'a mut [u8], len: uint }
* # let mut buf = [];
* let mut state = State { buffer: buf, len: 0 };
* try_finally(
* &mut state, (),
* |state, ()| {
* // use state.buffer, state.len
* }
* },
* |state| {
* // use state.buffer, state.len to cleanup
* })
Expand Down
8 changes: 4 additions & 4 deletions src/libstd/vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -955,7 +955,7 @@ pub trait ImmutableVector<'a, T> {
*
* Equivalent to:
*
* ```
* ```ignore
* if self.len() == 0 { return None }
* let head = &self[0];
* *self = self.slice_from(1);
Expand All @@ -973,7 +973,7 @@ pub trait ImmutableVector<'a, T> {
*
* Equivalent to:
*
* ```
* ```ignore
* if self.len() == 0 { return None; }
* let tail = &self[self.len() - 1];
* *self = self.slice_to(self.len() - 1);
Expand Down Expand Up @@ -2075,7 +2075,7 @@ pub trait MutableVector<'a, T> {
*
* Equivalent to:
*
* ```
* ```ignore
* if self.len() == 0 { return None; }
* let head = &mut self[0];
* *self = self.mut_slice_from(1);
Expand All @@ -2093,7 +2093,7 @@ pub trait MutableVector<'a, T> {
*
* Equivalent to:
*
* ```
* ```ignore
* if self.len() == 0 { return None; }
* let tail = &mut self[self.len() - 1];
* *self = self.mut_slice_to(self.len() - 1);
Expand Down
Loading

0 comments on commit e72ddbd

Please sign in to comment.