Add missing `options` param in Result's docs

2017-04-10 21:48:04 -05:00 · 2017-04-10 21:48:04 -05:00 · 8530f6fe98
parent eb86559702
commit 8530f6fe98
1 changed files with 3 additions and 2 deletions
--- a/lib/hunter/result.ex
+++ b/lib/hunter/result.ex
@ -28,11 +28,12 @@ defmodule Hunter.Result do
  # Parameters

    * `conn` - Connection credentials
-    * `q` - [String] The search query
+    * `q` - the search query
+    * `options` - option list

  ## Options

-    * `resolve` - [Boolean] Whether to resolve non-local accounts
+    * `resolve` - Whether to resolve non-local accounts

  """
  @spec search(Hunter.Client.t, String.t, Keyword.t) :: Hunter.Result.t