uesteibar / neuron

A GraphQL client for Elixir
https://hex.pm/packages/neuron
Other
331 stars 35 forks source link

Documentation error: Overriding HTTP Timeout #69

Open dingosky opened 2 years ago

dingosky commented 2 years ago

There is a simple error in the documentation regarding the example for overriding the default HTTP timeout of 5 seconds.

The code snippet: Neuron.Config.set(url: "https://example.com/graph", connection_opts: [recv_timeout: 15_000])

should be: Neuron.Config.set(url: "https://example.com/graph", connection_opts: [timeout: 15_000])

That is, the configuration option should be timeout, not recv_timeout.

Note the correct usage in the Neuron.Connection.HttpTest test "with custom connection options".