about summary refs log tree commit diff
path: root/src/liballoc
diff options
context:
space:
mode:
authorDavid Ross <daboross@daboross.net>2018-01-01 19:14:32 -0800
committerDavid Ross <daboross@daboross.net>2018-01-02 00:38:03 -0800
commitd5acd235658bd8d52db53aa10452620642b715dc (patch)
treee06aa5e42bdb5a934f703a01ff927f73d9f930a5 /src/liballoc
parentb65f0bedd2f22d9661ecb7092f07746dc2ccfb0d (diff)
downloadrust-d5acd235658bd8d52db53aa10452620642b715dc.tar.gz
rust-d5acd235658bd8d52db53aa10452620642b715dc.zip
Mention SliceConcatExt's stability in its docs
SliceConcatExt's status as an unstable trait with stable methods is
documented in the compiler error for using it, and in
https://doc.rust-lang.org/std/prelude/, but it is not mentioned in the
trait itself.

Mentioning the methods can be used in stable rust today should help
users who are looking for a `join` method while working on stable rust.
Diffstat (limited to 'src/liballoc')
-rw-r--r--src/liballoc/slice.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/liballoc/slice.rs b/src/liballoc/slice.rs
index ab574c9f7e7..fecea3339d2 100644
--- a/src/liballoc/slice.rs
+++ b/src/liballoc/slice.rs
@@ -1725,6 +1725,14 @@ impl [u8] {
            reason = "trait should not have to exist",
            issue = "27747")]
 /// An extension trait for concatenating slices
+///
+/// While this trait is unstable, the methods are stable. `SliceConcatExt` is
+/// included in the [standard library prelude], so you can use [`join()`] and
+/// [`concat()`] as if they existed on `[T]` itself.
+///
+/// [standard library prelude]: ../../std/prelude/index.html
+/// [`join()`]: #tymethod.join
+/// [`concat()`]: #tymethod.concat
 pub trait SliceConcatExt<T: ?Sized> {
     #[unstable(feature = "slice_concat_ext",
                reason = "trait should not have to exist",