update comments

jonabc · jonabc · commit d88eb773c46b · 2017-06-06T11:13:26.000-07:00
diff --git a/lib/github/ldap.rb b/lib/github/ldap.rb
@@ -65,7 +65,9 @@ class Ldap
     #   which to attempt opening connections (default [[host, port]]). Overrides
     #   host and port if set.
     # encryption: optional string. `ssl` or `tls`. nil by default
-    # tls_options: optional hash with TLS options for encrypted connections. Empty by default.
+    # tls_options: optional hash with TLS options for encrypted connections.
+    #   Empty by default. See http://ruby-doc.org/stdlib/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html
+    #   for available values
     # admin_user: optional string ldap administrator user dn for authentication
     # admin_password: optional string ldap administrator user password
     #
@@ -237,7 +239,7 @@ def capabilities
     # Internal - Determine whether to use encryption or not.
     #
     # encryption: is the encryption method, either 'ssl', 'tls', 'simple_tls' or 'start_tls'.
-    # validate: is true to enable certificate validation
+    # tls_options: is the options hash for tls encryption method
     #
     # Returns the real encryption type.
     def check_encryption(encryption, tls_options = {})

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,9 @@ class Ldap`
`65`	`65`	`# which to attempt opening connections (default [[host, port]]). Overrides`
`66`	`66`	`# host and port if set.`
`67`	`67`	# encryption: optional string. `ssl` or `tls`. nil by default
`68`		`- # tls_options: optional hash with TLS options for encrypted connections. Empty by default.`
	`68`	`+ # tls_options: optional hash with TLS options for encrypted connections.`
	`69`	`+ # Empty by default. See http://ruby-doc.org/stdlib/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html`
	`70`	`+ # for available values`
`69`	`71`	`# admin_user: optional string ldap administrator user dn for authentication`
`70`	`72`	`# admin_password: optional string ldap administrator user password`
`71`	`73`	`#`
`@@ -237,7 +239,7 @@ def capabilities`
`237`	`239`	`# Internal - Determine whether to use encryption or not.`
`238`	`240`	`#`
`239`	`241`	`# encryption: is the encryption method, either 'ssl', 'tls', 'simple_tls' or 'start_tls'.`
`240`		`- # validate: is true to enable certificate validation`
	`242`	`+ # tls_options: is the options hash for tls encryption method`
`241`	`243`	`#`
`242`	`244`	`# Returns the real encryption type.`
`243`	`245`	`def check_encryption(encryption, tls_options = {})`