diff options
| author | JessRudder <thejessicarudder@gmail.com> | 2016-08-11 18:44:19 -0400 |
|---|---|---|
| committer | JessRudder <thejessicarudder@gmail.com> | 2016-08-11 18:47:47 -0400 |
| commit | 91a2c25e2e8dc641decb04aba4e0338f199c8785 (patch) | |
| tree | 555bf44ddc93cac9be6d4dd89980b69e6a68403e /src/libstd | |
| parent | 11f880588791930cb130071c2cb972fc3c3354ed (diff) | |
| download | rust-91a2c25e2e8dc641decb04aba4e0338f199c8785.tar.gz rust-91a2c25e2e8dc641decb04aba4e0338f199c8785.zip | |
Add note to docs for &str that example is to demo internals only
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/primitive_docs.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs index de891ea8918..6a470a52aa6 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")] |