Merge pull request #3030 from practicalswift/normalization

[gardening] Remove invisible characters (^H and ^P). Normalize use of ', * and ".

Author: practicalswift

stdlib/public/SDK/Foundation/CharacterSet.swift

@@ -182,7 +182,7 @@ public struct CharacterSet : ReferenceConvertible, Equatable, Hashable, SetAlgeb
         return CharacterSet(reference: NSCharacterSet.alphanumerics() as NSCharacterSet)
     }
 
-    /// Returns a character set containing individual Unicode characters that can also be represented as composed character sequences (such as for letters with accents), by the definition of “standard decomposition” in version 3.2 of the Unicode character encoding standard.
+    /// Returns a character set containing individual Unicode characters that can also be represented as composed character sequences (such as for letters with accents), by the definition of "standard decomposition" in version 3.2 of the Unicode character encoding standard.
     public static var decomposables : CharacterSet {
         return CharacterSet(reference: NSCharacterSet.decomposables() as NSCharacterSet)
     }

stdlib/public/SDK/Foundation/Date.swift

@@ -64,7 +64,7 @@ public struct Date : ReferenceConvertible, Comparable, Equatable, CustomStringCo
     /**
     Returns the interval between the date object and 00:00:00 UTC on 1 January 2001.
 
-    This property’s value is negative if the date object is earlier than the system’s absolute reference date (00:00:00 UTC on 1 January 2001).
+    This property's value is negative if the date object is earlier than the system's absolute reference date (00:00:00 UTC on 1 January 2001).
     */
     public var timeIntervalSinceReferenceDate: TimeInterval {
         return _time
@@ -88,7 +88,7 @@ public struct Date : ReferenceConvertible, Comparable, Equatable, CustomStringCo
     /**
     The time interval between the date and the current date and time.
 
-    If the date is earlier than the current date and time, the this property’s value is negative.
+    If the date is earlier than the current date and time, the this property's value is negative.
 
     - SeeAlso: `timeIntervalSince(_:)`
     - SeeAlso: `timeIntervalSince1970`
@@ -101,7 +101,7 @@ public struct Date : ReferenceConvertible, Comparable, Equatable, CustomStringCo
     /**
     The interval between the date object and 00:00:00 UTC on 1 January 1970.
 
-    This property’s value is negative if the date object is earlier than 00:00:00 UTC on 1 January 1970.
+    This property's value is negative if the date object is earlier than 00:00:00 UTC on 1 January 1970.
 
     - SeeAlso: `timeIntervalSince(_:)`
     - SeeAlso: `timeIntervalSinceNow`
@@ -179,7 +179,7 @@ public struct Date : ReferenceConvertible, Comparable, Equatable, CustomStringCo
 
     - Parameter locale: A `Locale` object. If you pass `nil`, `NSDate` formats the date in the same way as the `description` property.
 
-    - Returns: A string representation of the receiver, using the given locale, or if the locale argument is `nil`, in the international format `YYYY-MM-DD HH:MM:SS ±HHMM`, where `±HHMM` represents the time zone offset in hours and minutes from UTC (for example, “`2001-03-24 10:45:32 +0600`”)
+    - Returns: A string representation of the receiver, using the given locale, or if the locale argument is `nil`, in the international format `YYYY-MM-DD HH:MM:SS ±HHMM`, where `±HHMM` represents the time zone offset in hours and minutes from UTC (for example, "`2001-03-24 10:45:32 +0600`")
     */
     public func description(with locale : Locale?) -> String {
         return NSDate(timeIntervalSinceReferenceDate: _time).description(with: locale)

stdlib/public/SDK/Foundation/IndexSet.swift

@@ -704,7 +704,7 @@ public struct IndexSet : ReferenceConvertible, Equatable, BidirectionalCollectio
     }
 }
 
-/// Iterate two index sets on the boundaries of their ranges. This is where all of the interesting stuff happens for exclusive or, intersect, etc.
+/// Iterate two index sets on the boundaries of their ranges. This is where all of the interesting stuff happens for exclusive or, intersect, etc.
 private struct IndexSetBoundaryIterator : IteratorProtocol {
     private typealias Element = IndexSet.Element
 

stdlib/public/SDK/Foundation/URL.swift

@@ -275,7 +275,7 @@ public struct URLResourceValues {
 
     /// The document identifier -- a value assigned by the kernel to a document (which can be either a file or directory) and is used to identify the document regardless of where it gets moved on a volume.
     ///
-    /// The document identifier survives "safe save” operations; i.e it is sticky to the path it was assigned to (`replaceItem(at:,withItemAt:,backupItemName:,options:,resultingItem:) throws` is the preferred safe-save API). The document identifier is persistent across system restarts. The document identifier is not transferred when the file is copied. Document identifiers are only unique within a single volume. This property is not supported by all volumes.
+    /// The document identifier survives "safe save" operations; i.e it is sticky to the path it was assigned to (`replaceItem(at:,withItemAt:,backupItemName:,options:,resultingItem:) throws` is the preferred safe-save API). The document identifier is persistent across system restarts. The document identifier is not transferred when the file is copied. Document identifiers are only unique within a single volume. This property is not supported by all volumes.
     @available(OSX 10.10, iOS 8.0, *)
     public var documentIdentifier: Int? { return _get(.documentIdentifierKey) }
 
@@ -471,7 +471,7 @@ public struct URLResourceValues {
 /**
  A URL is a type that can potentially contain the location of a resource on a remote server, the path of a local file on disk, or even an arbitrary piece of encoded data.
 
- You can construct URLs and access their parts. For URLs that represent local files, you can also manipulate properties of those files directly, such as changing the file’s last modification date. Finally, you can pass URLs to other APIs to retrieve the contents of those URLs. For example, you can use the URLSession classes to access the contents of remote resources, as described in URL Session Programming Guide.
+ You can construct URLs and access their parts. For URLs that represent local files, you can also manipulate properties of those files directly, such as changing the file's last modification date. Finally, you can pass URLs to other APIs to retrieve the contents of those URLs. For example, you can use the URLSession classes to access the contents of remote resources, as described in URL Session Programming Guide.
 
  URLs are the preferred way to refer to local files. Most objects that read data from or write data to a file have methods that accept a URL instead of a pathname as the file reference. For example, you can get the contents of a local file URL as `String` by calling `func init(contentsOf:encoding) throws`, or as a `Data` by calling `func init(contentsOf:options) throws`.
 */
@@ -673,7 +673,7 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
 
     /// Returns a file reference URL that refers to the same resource as a specified file URL.
     ///
-    /// File reference URLs use a URL path syntax that identifies a file system object by reference, not by path. This form of file URL remains valid when the file system path of the URL’s underlying resource changes. An error will occur if the url parameter is not a file URL. File reference URLs cannot be created to file system objects which do not exist or are not reachable. In some areas of the file system hierarchy, file reference URLs cannot be generated to the leaf node of the URL path. A file reference URL's path should never be persistently stored because is not valid across system restarts, and across remounts of volumes -- if you want to create a persistent reference to a file system object, use a bookmark.
+    /// File reference URLs use a URL path syntax that identifies a file system object by reference, not by path. This form of file URL remains valid when the file system path of the URL's underlying resource changes. An error will occur if the url parameter is not a file URL. File reference URLs cannot be created to file system objects which do not exist or are not reachable. In some areas of the file system hierarchy, file reference URLs cannot be generated to the leaf node of the URL path. A file reference URL's path should never be persistently stored because is not valid across system restarts, and across remounts of volumes -- if you want to create a persistent reference to a file system object, use a bookmark.
     /// - seealso: func bookmarkData(options: BookmarkCreationOptions = [], includingResourceValuesForKeys keys: Set<URLResourceKey>? = nil, relativeTo url: URL? = nil) throws -> Data
     public func fileReferenceURL() throws -> URL {
         if let result = _url.fileReferenceURL().map({ URL(reference: $0 as NSURL) }) {
@@ -711,12 +711,12 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
         // TODO: Use URLComponents to handle an empty-path case
         /*
          URLByAppendingPathComponent can return nil if:
-         • the URL does not have a path component. (see note 1)
-         • a mutable copy of the URLs string could not be created.
-         • a percent-encoded string of the new path component could not created using the same encoding as the URL’s string. (see note 2)
-         • a new URL object could not be created with the modified URL string.
+         * the URL does not have a path component. (see note 1)
+         * a mutable copy of the URLs string could not be created.
+         * a percent-encoded string of the new path component could not created using the same encoding as the URL's string. (see note 2)
+         * a new URL object could not be created with the modified URL string.
 
-         Note 1: If NS/CFURL parsed URLs correctly, this would not occur because URL strings always have a path component. For example, the URL <mailto:[email protected]> should be parsed as Scheme=“mailto”, and Path= “[email protected]". Instead, CFURL returns false for CFURLCanBeDecomposed(), says Scheme=“mailto”, Path=nil, and ResourceSpecifier=“[email protected]”. rdar://problem/15060399
+         Note 1: If NS/CFURL parsed URLs correctly, this would not occur because URL strings always have a path component. For example, the URL <mailto:[email protected]> should be parsed as Scheme="mailto", and Path= "[email protected]". Instead, CFURL returns false for CFURLCanBeDecomposed(), says Scheme="mailto", Path=nil, and ResourceSpecifier="[email protected]". rdar://problem/15060399
 
          Note 2: CFURLCreateWithBytes() and CFURLCreateAbsoluteURLWithBytes() allow URLs to be created with an array of bytes and a CFStringEncoding. All other CFURL functions and URL methods which create URLs use kCFStringEncodingUTF8/NSUTF8StringEncoding. So, the encoding passed to CFURLCreateWithBytes/CFURLCreateAbsoluteURLWithBytes might prevent the percent-encoding of the new path component or path extension.
          */
@@ -742,10 +742,10 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
     public func deletingLastPathComponent() throws -> URL {
         /*
          URLByDeletingLastPathComponent can return nil if:
-         • the URL is a file reference URL which cannot be resolved back to a path.
-         • the URL does not have a path component. (see note 1)
-         • a mutable copy of the URLs string could not be created.
-         • a new URL object could not be created with the modified URL string.
+         * the URL is a file reference URL which cannot be resolved back to a path.
+         * the URL does not have a path component. (see note 1)
+         * a mutable copy of the URLs string could not be created.
+         * a new URL object could not be created with the modified URL string.
          */
         if let result = _url.deletingLastPathComponent.map({ URL(reference: $0 as NSURL) }) {
             return result
@@ -762,12 +762,12 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
     public func appendingPathExtension(_ pathExtension: String) throws -> URL {
         /*
          URLByAppendingPathExtension can return nil if:
-         • the new path extension is not a valid extension (see _CFExtensionIsValidToAppend)
-         • the URL is a file reference URL which cannot be resolved back to a path.
-         • the URL does not have a path component. (see note 1)
-         • a mutable copy of the URLs string could not be created.
-         • a percent-encoded string of the new path extension could not created using the same encoding as the URL’s string. (see note 1))
-         • a new URL object could not be created with the modified URL string.
+         * the new path extension is not a valid extension (see _CFExtensionIsValidToAppend)
+         * the URL is a file reference URL which cannot be resolved back to a path.
+         * the URL does not have a path component. (see note 1)
+         * a mutable copy of the URLs string could not be created.
+         * a percent-encoded string of the new path extension could not created using the same encoding as the URL's string. (see note 1))
+         * a new URL object could not be created with the modified URL string.
          */
         guard let result = _url.appendingPathExtension(pathExtension) else {
             throw NSError(domain: NSCocoaErrorDomain, code: NSFileReadUnknownError, userInfo: [:])
@@ -781,10 +781,10 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
     public func deletingPathExtension() throws -> URL {
         /*
          URLByDeletingPathExtension can return nil if:
-         • the URL is a file reference URL which cannot be resolved back to a path.
-         • the URL does not have a path component. (see note 1)
-         • a mutable copy of the URLs string could not be created.
-         • a new URL object could not be created with the modified URL string.
+         * the URL is a file reference URL which cannot be resolved back to a path.
+         * the URL does not have a path component. (see note 1)
+         * a mutable copy of the URLs string could not be created.
+         * a new URL object could not be created with the modified URL string.
          */
         if let result = _url.deletingPathExtension.map({ URL(reference: $0 as NSURL) }) {
             return result
@@ -801,8 +801,8 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
     public func standardizingPath() throws -> URL {
         /*
          URLByStandardizingPath can return nil if:
-         • the URL is a file reference URL which cannot be resolved back to a path.
-         • a new URL object could not be created with the standardized path).
+         * the URL is a file reference URL which cannot be resolved back to a path.
+         * a new URL object could not be created with the standardized path).
          */
         if let result = _url.standardizingPath.map({ URL(reference: $0 as NSURL) }) {
             return result
@@ -819,9 +819,9 @@ public struct URL : ReferenceConvertible, CustomStringConvertible, Equatable {
     public func resolvingSymlinksInPath() throws -> URL {
         /*
          URLByResolvingSymlinksInPath can return nil if:
-         • the URL is a file reference URL which cannot be resolved back to a path.
-         • NSPathUtilities’ stringByResolvingSymlinksInPath property returns nil.
-         • a new URL object could not be created with the resolved path).
+         * the URL is a file reference URL which cannot be resolved back to a path.
+         * NSPathUtilities' stringByResolvingSymlinksInPath property returns nil.
+         * a new URL object could not be created with the resolved path).
          */
         if let result = _url.resolvingSymlinksInPath.map({ URL(reference: $0 as NSURL) }) {
             return result

stdlib/public/SDK/Foundation/URLComponents.swift

@@ -266,7 +266,7 @@ public struct URLComponents : ReferenceConvertible, Hashable, CustomStringConver
     ///
     /// Each `URLQueryItem` represents a single key-value pair,
     ///
-    /// Note that a name may appear more than once in a single query string, so the name values are not guaranteed to be unique. If the `URLComponents` has an empty query component, returns an empty array. If the `URLComponents` has no query component, returns nil.
+    /// Note that a name may appear more than once in a single query string, so the name values are not guaranteed to be unique. If the `URLComponents` has an empty query component, returns an empty array. If the `URLComponents` has no query component, returns nil.
     ///
     /// The setter combines an array containing any number of `URLQueryItem`s, each of which represents a single key-value pair, into a query string and sets the `URLComponents` query property. Passing an empty array sets the query component of the `URLComponents` to an empty string. Passing nil removes the query component of the `URLComponents`.
     ///