From 96d0a77091b40f21038ea99ba2359f90be013ac0 Mon Sep 17 00:00:00 2001 From: Brian Alexander Date: Fri, 10 May 2024 17:02:59 -0600 Subject: [PATCH] update docs --- CHANGELOG.md | 1 + lib/sanity.ex | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 94a4f36..7c69ad7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - (BREAKING) Switch HTTP client from `finch` to `req` (https://github.com/balexand/sanity/pull/81). This introduces the following breaking changes: - The `headers` field of the `Sanity.Response` now returns a map instead of a list of tuples. See https://hexdocs.pm/req/changelog.html#change-headers-to-be-maps for details. + - The `:http_options` option for `Sanity.request/2` is now passed to `Req.request/1` instead of to Finch. The available options will be different. - The `:max_attempts` and `:retry_delay` options have been removed from `Sanity.request/2`. `Req` handles retries for us. - The `source` field in the `Sanity.Error` exception may now contain a `Req.Response` struct instead of a `Finch.Response`. diff --git a/lib/sanity.ex b/lib/sanity.ex index 7d7ffea..b534aef 100644 --- a/lib/sanity.ex +++ b/lib/sanity.ex @@ -39,7 +39,7 @@ defmodule Sanity do http_options: [ type: :keyword_list, default: [receive_timeout: 30_000], - doc: "Options to be passed to `Req.request/2`." + doc: "Options to be passed to `Req.request/1`." ], project_id: [ type: :string,