First pass at uniformed types, specs and docs

- spec public functions (skipping controllers, views, live views and
components)
- use types instead of explanations in docs
- remove redundant docs
- fix typos
This commit is contained in:
Claudio Ortolina
2026-03-06 08:33:11 +00:00
parent 99e30d5fdf
commit 7cf9b4e7f8
81 changed files with 652 additions and 300 deletions
+3
View File
@@ -5,6 +5,7 @@ defmodule Discogs.API do
require Logger
@spec get_artist(integer() | String.t(), Discogs.Config.t()) :: {:ok, map()} | {:error, term()}
def get_artist(id, config) do
config
|> new_request()
@@ -15,6 +16,8 @@ defmodule Discogs.API do
|> get_request()
end
@spec get_artist_image(String.t(), Discogs.Config.t()) ::
{:ok, binary()} | {:error, :cover_not_available}
def get_artist_image(url, config) do
case Req.new(url: url, max_retries: 1, user_agent: config.user_agent)
|> Req.Request.merge_options(config.req_options)