From 91a2c25e2e8dc641decb04aba4e0338f199c8785 Mon Sep 17 00:00:00 2001 From: JessRudder Date: Thu, 11 Aug 2016 18:44:19 -0400 Subject: [PATCH 1/2] Add note to docs for &str that example is to demo internals only --- src/libstd/primitive_docs.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs index de891ea89189a..6a470a52aa66c 100644 --- a/src/libstd/primitive_docs.rs +++ b/src/libstd/primitive_docs.rs @@ -385,6 +385,9 @@ mod prim_slice { } /// /// [`.as_ptr()`]: #method.as_ptr /// [`len()`]: #method.len +/// +/// Note: This example shows the internals of `&str`. `unsafe` should not be +/// used to get a string slice under normal circumstances. mod prim_str { } #[doc(primitive = "tuple")] From 758aff7883b846a9ea01ee6c810f77a4a08c8a48 Mon Sep 17 00:00:00 2001 From: JessRudder Date: Fri, 12 Aug 2016 10:39:40 -0400 Subject: [PATCH 2/2] Update note to include recommendation to use `.as_slice()` --- src/libstd/primitive_docs.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs index 6a470a52aa66c..84618ba2593a8 100644 --- a/src/libstd/primitive_docs.rs +++ b/src/libstd/primitive_docs.rs @@ -387,7 +387,8 @@ mod prim_slice { } /// [`len()`]: #method.len /// /// Note: This example shows the internals of `&str`. `unsafe` should not be -/// used to get a string slice under normal circumstances. +/// used to get a string slice under normal circumstances. Use `.as_slice()` +/// instead. mod prim_str { } #[doc(primitive = "tuple")]