From 6549c9b1d7484ee57ce6a88fed144686bdccae8f Mon Sep 17 00:00:00 2001 From: Ben Wilson Date: Sat, 11 Jul 2015 12:47:10 -0400 Subject: [PATCH] a couple minor documentation fixes --- lib/ex_aws/client.ex | 5 ++++- lib/ex_aws/lambda/client.ex | 2 +- lib/ex_aws/s3/client.ex | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/ex_aws/client.ex b/lib/ex_aws/client.ex index 8f759334..8c4e3dc3 100644 --- a/lib/ex_aws/client.ex +++ b/lib/ex_aws/client.ex @@ -21,8 +21,11 @@ defmodule ExAws.Client do end def create_config_boilerplate(client, opts) do + << "Elixir.", client_name::binary>> = client |> Atom.to_string quote do - @moduledoc false + @moduledoc """ + Consult the documentation in #{unquote(client_name)} + """ @otp_app Keyword.get(unquote(opts), :otp_app) @behaviour unquote(client) diff --git a/lib/ex_aws/lambda/client.ex b/lib/ex_aws/lambda/client.ex index b2f68bae..5d287eb3 100644 --- a/lib/ex_aws/lambda/client.ex +++ b/lib/ex_aws/lambda/client.ex @@ -14,7 +14,7 @@ defmodule ExAws.Lambda.Client do In your config ``` - config :my_otp_app, ExAws, + config :my_otp_app, :ex_aws, lambda: [], # lambda config goes here ``` diff --git a/lib/ex_aws/s3/client.ex b/lib/ex_aws/s3/client.ex index b61a0598..ea197b27 100644 --- a/lib/ex_aws/s3/client.ex +++ b/lib/ex_aws/s3/client.ex @@ -14,7 +14,7 @@ defmodule ExAws.S3.Client do In your config ``` - config :my_otp_app, ExAws, + config :my_otp_app, :ex_aws, s3: [], # S3 config goes here ```