about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorJonathan Turner <jonathandturner@users.noreply.github.com>2016-09-22 11:25:01 -0700
committerGitHub <noreply@github.com>2016-09-22 11:25:01 -0700
commit5d4c0edb695fb3d13a36ee6a2edf2c0f0fd2a98c (patch)
tree66889a88ea29365ea21e920137d5ad79e7d39f29 /src/libcore
parenta86c83f08af3dd4b1bcf627ecc5e1f9d3926c9c4 (diff)
parent8b02aa1c800dd4c7a40a01e648507b0edfa07229 (diff)
downloadrust-5d4c0edb695fb3d13a36ee6a2edf2c0f0fd2a98c.tar.gz
rust-5d4c0edb695fb3d13a36ee6a2edf2c0f0fd2a98c.zip
Rollup merge of #36589 - jpadkins:option_docs_safety_wording_fix, r=bluss
fixed the safety header/wording in option.rs

Fixes #36581

screenshot of the rendered documentation: http://imgur.com/14kLVrA

r? @steveklabnik
Diffstat (limited to 'src/libcore')
-rw-r--r--src/libcore/option.rs10
1 files changed, 4 insertions, 6 deletions
diff --git a/src/libcore/option.rs b/src/libcore/option.rs
index b9fb2dc90c7..cb18feff734 100644
--- a/src/libcore/option.rs
+++ b/src/libcore/option.rs
@@ -296,16 +296,14 @@ impl<T> Option<T> {
 
     /// Moves the value `v` out of the `Option<T>` if it is `Some(v)`.
     ///
-    /// # Panics
-    ///
-    /// Panics if the self value equals `None`.
-    ///
-    /// # Safety note
-    ///
     /// In general, because this function may panic, its use is discouraged.
     /// Instead, prefer to use pattern matching and handle the `None`
     /// case explicitly.
     ///
+    /// # Panics
+    ///
+    /// Panics if the self value equals `None`.
+    ///
     /// # Examples
     ///
     /// ```