summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHubert Chathi <hubert@uhoreg.ca>2020-09-17 22:55:21 -0400
committerHubert Chathi <hubert@uhoreg.ca>2020-09-17 22:55:21 -0400
commit06c314dcc5d01cd172a8dcbd44756be10f86c597 (patch)
treece6bfe15387999965ce4ddf3b4aafa2bed583577
parentimprove endpoint protocol and HttpSpec (diff)
doc improvements
-rw-r--r--lib/polyjuice/client/endpoint.ex7
-rw-r--r--mix.exs7
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)
diff --git a/mix.exs b/mix.exs
index 4addbbd..edd3363 100644
--- a/mix.exs
+++ b/mix.exs
@@ -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: [