about summary refs log tree commit diff
path: root/src/libcore/num
diff options
context:
space:
mode:
authorSimon Heath <icefox@dreamquest.io>2019-02-27 09:54:37 -0500
committerSimon Sapin <simon.sapin@exyr.org>2019-02-27 16:03:11 +0100
commit5dce719520a49b305b668a00ad25cb4731048670 (patch)
tree87bc1bb7810a1aef76941ab2879f9ae4ab3e0b23 /src/libcore/num
parent60cf413a20392ae38ffbf945e3d77f892655a74f (diff)
downloadrust-5dce719520a49b305b668a00ad25cb4731048670.tar.gz
rust-5dce719520a49b305b668a00ad25cb4731048670.zip
Vastly simplify TryFrom docs.
Diffstat (limited to 'src/libcore/num')
-rw-r--r--src/libcore/num/mod.rs36
1 files changed, 8 insertions, 28 deletions
diff --git a/src/libcore/num/mod.rs b/src/libcore/num/mod.rs
index 4a2f958b93f..d08aa079dbd 100644
--- a/src/libcore/num/mod.rs
+++ b/src/libcore/num/mod.rs
@@ -4545,13 +4545,8 @@ macro_rules! try_from_unbounded {
             type Error = TryFromIntError;
 
             /// Try to create the target number type from a source
-            /// number type.  If the source type has a larger range
-            /// than the target, or their ranges are disjoint (such
-            /// as converting a signed to unsigned number or vice 
-            /// versa), this will return `None` if the source value
-            /// doesn't fit into the range of the destination value.
-            /// If the conversion can never fail, this is still
-            /// implemented for completeness's sake.
+            /// number type. This returns an error if the source value
+            /// is outside of the range of the target type.
             #[inline]
             fn try_from(value: $source) -> Result<Self, Self::Error> {
                 Ok(value as $target)
@@ -4568,13 +4563,8 @@ macro_rules! try_from_lower_bounded {
             type Error = TryFromIntError;
 
             /// Try to create the target number type from a source
-            /// number type.  If the source type has a larger range
-            /// than the target, or their ranges are disjoint (such
-            /// as converting a signed to unsigned number or vice 
-            /// versa), this will return `None` if the source value
-            /// doesn't fit into the range of the destination value.
-            /// If the conversion can never fail, this is still
-            /// implemented for completeness's sake.
+            /// number type. This returns an error if the source value
+            /// is outside of the range of the target type.
             #[inline]
             fn try_from(u: $source) -> Result<$target, TryFromIntError> {
                 if u >= 0 {
@@ -4595,13 +4585,8 @@ macro_rules! try_from_upper_bounded {
             type Error = TryFromIntError;
 
             /// Try to create the target number type from a source
-            /// number type.  If the source type has a larger range
-            /// than the target, or their ranges are disjoint (such
-            /// as converting a signed to unsigned number or vice 
-            /// versa), this will return `None` if the source value
-            /// doesn't fit into the range of the destination value.
-            /// If the conversion can never fail, this is still
-            /// implemented for completeness's sake.
+            /// number type. This returns an error if the source value
+            /// is outside of the range of the target type.
             #[inline]
             fn try_from(u: $source) -> Result<$target, TryFromIntError> {
                 if u > (<$target>::max_value() as $source) {
@@ -4622,13 +4607,8 @@ macro_rules! try_from_both_bounded {
             type Error = TryFromIntError;
 
             /// Try to create the target number type from a source
-            /// number type.  If the source type has a larger range
-            /// than the target, or their ranges are disjoint (such
-            /// as converting a signed to unsigned number or vice 
-            /// versa), this will return `None` if the source value
-            /// doesn't fit into the range of the destination value.
-            /// If the conversion can never fail, this is still
-            /// implemented for completeness's sake.
+            /// number type. This returns an error if the source value
+            /// is outside of the range of the target type.
             #[inline]
             fn try_from(u: $source) -> Result<$target, TryFromIntError> {
                 let min = <$target>::min_value() as $source;