TLS review markups

Signed-off-by: Richard Whitehouse <richard.whitehouse@metaswitch.com>

Author: richardwhiuk

CHANGELOG.md

@@ -13,11 +13,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Allow HTTPS connectors to be built which don't pin the server CA certificate
 - Allow HTTPS to work on Mac/Windows/iOS
 - Enforce that HTTPS is used if we are using a HTTPS connector.
-- Return Results, rather than unwrapping errors on client creation
+- Return Results, rather than unwrapping errors on connector creation
 - openssl 0.10
 
 ### Removed
-- Remove HTTPS methods for Mac OS X, iOS and Windows
 
 ## [3.2.0] - 2020-02-12
 ### Added

src/connector.rs

@@ -71,7 +71,7 @@ impl HttpsBuilder {
     ///
     /// * `ca_certificate` - Path to CA certificate used to authenticate the server
     #[cfg(not(any(target_os = "macos", target_os = "windows", target_os = "ios")))]
-    pub fn pin_server<CA>(mut self, ca_certificate: CA) -> Self
+    pub fn pin_server_certificate<CA>(mut self, ca_certificate: CA) -> Self
     where
         CA: AsRef<Path>,
     {
@@ -86,7 +86,7 @@ impl HttpsBuilder {
     /// * `client_key` - Path to the client private key
     /// * `client_certificate` - Path to the client's public certificate associated with the private key
     #[cfg(not(any(target_os = "macos", target_os = "windows", target_os = "ios")))]
-    pub fn client<K, C>(mut self, client_key: K, client_certificate: C) -> Self
+    pub fn client_authentication<K, C>(mut self, client_key: K, client_certificate: C) -> Self
     where
         K: AsRef<Path>,
         C: AsRef<Path>,
@@ -130,7 +130,7 @@ impl HttpsBuilder {
     }
 
     #[cfg(any(target_os = "macos", target_os = "windows", target_os = "ios"))]
-    /// Build the HTTPS connector. Will if the SSL connector can't be created.
+    /// Build the HTTPS connector. Will fail if the SSL connector can't be created.
     pub fn build(
         self,
     ) -> Result<hyper_tls::HttpsConnector<hyper::client::HttpConnector>, native_tls::Error> {