Skip to content

Commit

Permalink
rollup merge of rust-lang#20632: gchp/reference
Browse files Browse the repository at this point in the history
I noticed that the `deriving` keyword is deprecated and that `derive` is the replacement. This updates the reference (and other docs) to remove the use `deriving`.
  • Loading branch information
alexcrichton committed Jan 15, 2015
2 parents baee204 + 4b14f67 commit 855c3e5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions src/doc/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2432,15 +2432,15 @@ There are three different types of inline attributes:
* `#[inline(always)]` asks the compiler to always perform an inline expansion.
* `#[inline(never)]` asks the compiler to never perform an inline expansion.

### Deriving
### Derive

The `deriving` attribute allows certain traits to be automatically implemented
The `derive` attribute allows certain traits to be automatically implemented
for data structures. For example, the following will create an `impl` for the
`PartialEq` and `Clone` traits for `Foo`, the type parameter `T` will be given
the `PartialEq` or `Clone` constraints for the appropriate `impl`:

```
#[deriving(PartialEq, Clone)]
#[derive(PartialEq, Clone)]
struct Foo<T> {
a: int,
b: T
Expand All @@ -2462,7 +2462,7 @@ impl<T: PartialEq> PartialEq for Foo<T> {
}
```

Supported traits for `deriving` are:
Supported traits for `derive` are:

* Comparison traits: `PartialEq`, `Eq`, `PartialOrd`, `Ord`.
* Serialization: `Encodable`, `Decodable`. These require `serialize`.
Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustdoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Rustdoc also supplies some extra sugar for helping with some tedious
documentation examples. If a line is prefixed with `# `, then the line
will not show up in the HTML documentation, but it will be used when
testing the code block (NB. the space after the `#` is required, so
that one can still write things like `#[deriving(Eq)]`).
that one can still write things like `#[derive(Eq)]`).

~~~md
```
Expand Down
2 changes: 1 addition & 1 deletion src/doc/trpl/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ The advantages over a simple `fn(&str) -> uint` are:
a way to define new literal syntax for any data type.

In addition to procedural macros, you can define new
[`deriving`](../reference.html#deriving)-like attributes and other kinds of
[`derive`](../reference.html#derive)-like attributes and other kinds of
extensions. See
[`Registry::register_syntax_extension`](../rustc/plugin/registry/struct.Registry.html#method.register_syntax_extension)
and the [`SyntaxExtension`
Expand Down

0 comments on commit 855c3e5

Please sign in to comment.