Merge pull request #3898 from natecook1000/nc-revise-fp

[stdlib] Revise and expand floating-point documentation

Author: gottesmm

stdlib/public/core/Comparable.swift

@@ -131,8 +131,8 @@
 /// - Note: A conforming type may contain a subset of values which are treated
 ///   as exceptional---that is, values that are outside the domain of
 ///   meaningful arguments for the purposes of the `Comparable` protocol. For
-///   example, the special not-a-number (`FloatingPoint.nan`) value for
-///   floating-point types compares as neither less than, greater than, nor
+///   example, the special "not a number" value for floating-point types
+///   (`FloatingPoint.nan`) compares as neither less than, greater than, nor
 ///   equal to any normal floating-point value. Exceptional values need not
 ///   take part in the strict total order.
 public protocol Comparable : Equatable {

stdlib/public/core/CompilerProtocols.swift

@@ -205,10 +205,32 @@ public protocol _ExpressibleByBuiltinFloatLiteral {
   init(_builtinFloatLiteral value: _MaxBuiltinFloatType)
 }
 
-/// Conforming types can be initialized with floating point literals.
+/// A type that can be initialized with a floating-point literal.
+///
+/// The standard library floating-point types---`Float`, `Double`, and
+/// `Float80` where available---all conform to the `ExpressibleByFloatLiteral`
+/// protocol. You can initialize a variable or constant of any of these types
+/// by assigning a floating-point literal.
+///
+///     // Type inferred as 'Double'
+///     let threshold = 6.0
+///
+///     // An array of 'Double'
+///     let measurements = [2.2, 4.1, 3.65, 4.2, 9.1]
+///
+/// Conforming to ExpressibleByFloatLiteral
+/// =======================================
+///
+/// To add `ExpressibleByFloatLiteral` conformance to your custom type,
+/// implement the required initializer.
 public protocol ExpressibleByFloatLiteral {
+  /// A type that can represent a floating-point literal.
+  ///
+  /// Valid types for `FloatLiteralType` are `Float`, `Double`, and `Float80`
+  /// where available.
   associatedtype FloatLiteralType : _ExpressibleByBuiltinFloatLiteral
-  /// Create an instance initialized to `value`.
+  
+  /// Creates an instance initialized to the specified floating-point value.
   init(floatLiteral value: FloatLiteralType)
 }