docs(client): correct comment about tls::Context.domain's usage

google · Jan 27, 2017 · f0dd32e · f0dd32e
1 parent 9f358a8
commit f0dd32e
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/client.rs b/src/client.rs
@@ -38,8 +38,11 @@ pub mod tls {
     }
 
     impl Context {
-        /// Try to construct a new `Context`, providing the domain the client will
-        /// connect to.
+        /// Try to construct a new `Context`.
+        ///
+        /// The provided domain will be used for both
+        /// [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication) and certificate hostname
+        /// validation.
         pub fn new<S: Into<String>>(domain: S) -> Result<Self, ::tls::NativeTlsError> {
             Ok(Context {
                 domain: domain.into(),
@@ -48,6 +51,10 @@ pub mod tls {
         }
 
         /// Construct a new `Context` using the provided domain and `TlsConnector`
+        ///
+        /// The domain will be used for both
+        /// [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication) and certificate hostname
+        /// validation.
         pub fn from_connector<S: Into<String>>(domain: S, tls_connector: TlsConnector) -> Self {
             Context {
                 domain: domain.into(),