From c91c39fad1cb99f4858cef1d5a27a178265f4ba5 Mon Sep 17 00:00:00 2001 From: Zemuldo Date: Thu, 9 Nov 2023 23:18:53 +0300 Subject: [PATCH] fix docs --- lib/ex_secrets.ex | 6 +++--- mix.exs | 19 ++++++++++++------- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/lib/ex_secrets.ex b/lib/ex_secrets.ex index c1fb495..495a29b 100644 --- a/lib/ex_secrets.ex +++ b/lib/ex_secrets.ex @@ -12,8 +12,8 @@ defmodule ExSecrets do @doc """ Get secret value. You can pass two options: - - provider: Name of the provider to use. Default is :system_env - - default_value: Default value to return if secret is not found. Default is nil + - provider: Name of the provider to use. Default is :system_env + - default_value: Default value to return if secret is not found. Default is nil ## Examples @@ -109,7 +109,7 @@ defmodule ExSecrets do @doc """ Get secret value with provider name and default value """ - @deprecated "This function is deprecated. Use get/2 instead." + @deprecated "Use get/2 instead." def get(key, provider, default) do case get(key, provider: provider) do nil -> default diff --git a/mix.exs b/mix.exs index a49a31c..d61db4b 100644 --- a/mix.exs +++ b/mix.exs @@ -4,19 +4,14 @@ defmodule ExSecrets.MixProject do def project do [ app: :ex_secrets, - version: "0.3.1", + version: "0.3.2", elixir: "~> 1.13", build_embedded: Mix.env() == :prod, start_permanent: Mix.env() == :prod, description: description(), package: package(), deps: deps(), - docs: [ - # The main page in the docs - main: "readme", - logo: "logo.png", - extras: ["README.md", "GUIDES.md", "CHANGELOG.md", "LICENSE"] - ] + docs: docs() ] end @@ -63,4 +58,14 @@ defmodule ExSecrets.MixProject do links: %{"GitHub" => "https://github.com/zemuldo/ex_secrets"} ] end + + defp docs() do + [ + source_url: "https://github.com/zemuldo/ex_secrets", + source_ref: "main", + main: "readme", + logo: "logo.png", + extras: ["README.md", "GUIDES.md", "CHANGELOG.md", "LICENSE"] + ] + end end