Tweak to search documentation

Dave Sims · Dave Sims · commit afa1f6aa7a6f · 2016-07-11T09:52:12.000-05:00
diff --git a/lib/github/ldap/forest_search.rb b/lib/github/ldap/forest_search.rb
@@ -22,8 +22,8 @@ def initialize(connection, naming_context)
 
       # Search over all domain controllers in the ActiveDirectory forest.
       #
-      # options: options hash passed in from GitHub::Ldap#search
-      # &block:  optional block passed in from GitHub::Ldap#search
+      # options: is a hash with the same options that Net::LDAP::Connection#search supports.
+      # block: is an optional block to pass to the search.
       #
       # If no domain controllers are found in the forest, fall back on searching
       # the main GitHub::Ldap object in @connection.

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ def initialize(connection, naming_context)`
`22`	`22`
`23`	`23`	`# Search over all domain controllers in the ActiveDirectory forest.`
`24`	`24`	`#`
`25`		`- # options: options hash passed in from GitHub::Ldap#search`
`26`		`- # &block: optional block passed in from GitHub::Ldap#search`
	`25`	`+ # options: is a hash with the same options that Net::LDAP::Connection#search supports.`
	`26`	`+ # block: is an optional block to pass to the search.`
`27`	`27`	`#`
`28`	`28`	`# If no domain controllers are found in the forest, fall back on searching`
`29`	`29`	`# the main GitHub::Ldap object in @connection.`