Merge pull request #95 from johannesfrey/description-for-params-option

Add description for the :params option
edgurgel · Nov 10, 2015 · 87aabe1 · 87aabe1
2 parents 82dad16 + 80d251e
commit 87aabe1
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lib/httpoison/base.ex b/lib/httpoison/base.ex
@@ -133,6 +133,7 @@ defmodule HTTPoison.Base do
         * `:ssl` - SSL options supported by the `ssl` erlang module
         * `:follow_redirect` - a boolean that causes redirects to be followed
         * `:max_redirect` - an integer denoting the maximum number of redirects to follow
+        * `:params` - an enumerable consisting of two-item tuples that will be appended to the url as query string parameters
 
       Timeouts can be an integer or `:infinity`