diff options
| author | bors <bors@rust-lang.org> | 2014-12-24 20:47:12 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2014-12-24 20:47:12 +0000 |
| commit | 7e11b22713aebd28ceaaa2ecef937c9b9d247c2f (patch) | |
| tree | 10885e6c690c4786c1eddab369ba92090732ddf8 /src/doc/reference.md | |
| parent | 14597f980a19aad66cd72e9ac4b6cd43b24ea5f4 (diff) | |
| parent | 85c1a4b1ba09dae786b3554e0ab596814efabe0e (diff) | |
auto merge of #20117 : lfairy/rust/rename-include-bin, r=alexcrichton
According to [RFC 344][], methods that return `&[u8]` should have names ending in `bytes`. Though `include_bin!` is a macro not a method, it seems reasonable to follow the convention anyway. We keep the old name around for now, but trigger a deprecation warning when it is used. [RFC 344]: https://github.com/rust-lang/rfcs/blob/master/text/0344-conventions-galore.md [breaking-change]
Diffstat (limited to 'src/doc/reference.md')
| -rw-r--r-- | src/doc/reference.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index 97184d53498..b71994c9836 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -640,7 +640,7 @@ names, and invoked through a consistent syntax: `name!(...)`. Examples include: * `stringify!` : pretty-print the Rust expression given as an argument * `include!` : include the Rust expression in the given file * `include_str!` : include the contents of the given file as a string -* `include_bin!` : include the contents of the given file as a binary blob +* `include_bytes!` : include the contents of the given file as a binary blob * `error!`, `warn!`, `info!`, `debug!` : provide diagnostic information. All of the above extensions are expressions with values. |