diff options
author | Hubert Chathi <hubert@uhoreg.ca> | 2020-09-17 22:55:21 -0400 |
---|---|---|
committer | Hubert Chathi <hubert@uhoreg.ca> | 2020-09-17 22:55:21 -0400 |
commit | 06c314dcc5d01cd172a8dcbd44756be10f86c597 (patch) | |
tree | ce6bfe15387999965ce4ddf3b4aafa2bed583577 | |
parent | improve endpoint protocol and HttpSpec (diff) |
doc improvements
-rw-r--r-- | lib/polyjuice/client/endpoint.ex | 7 | ||||
-rw-r--r-- | mix.exs | 7 |
2 files changed, 12 insertions, 2 deletions
diff --git a/lib/polyjuice/client/endpoint.ex b/lib/polyjuice/client/endpoint.ex index f41b5ec..66a97a9 100644 --- a/lib/polyjuice/client/endpoint.ex +++ b/lib/polyjuice/client/endpoint.ex @@ -13,8 +13,6 @@ # limitations under the License. defmodule Polyjuice.Client.Endpoint do - @moduledoc false - defmodule HttpSpec do @typedoc """ The description of how to handle the endpoint. @@ -178,6 +176,11 @@ defmodule Polyjuice.Client.Endpoint do end end + @spec get_header( + headers :: list({String.t(), String.t()}), + name :: String.t(), + default :: any + ) :: any def get_header(headers, name, default \\ nil) do name = String.downcase(name, :ascii) @@ -23,6 +23,13 @@ defmodule PolyjuiceClient.MixProject do "README.md", "tutorial_echo.md", "tutorial_welcome.md" + ], + groups_for_modules: [ + Endpoints: [ + ~r/Polyjuice\.Client\.Endpoint\.Get.*/, + ~r/Polyjuice\.Client\.Endpoint\.Post.*/, + ~r/Polyjuice\.Client\.Endpoint\.Put.*/ + ] ] ], package: [ |