From 13c622f5d59ba51d9e9f9e8ad0cb560b8f98e75e Mon Sep 17 00:00:00 2001 From: Miles Sorlie Date: Fri, 11 Sep 2020 16:08:56 -0600 Subject: [PATCH 1/2] add example for leading underscore function names --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 410a421..4137133 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,10 @@ The following section are automatically applied by the code formatter in Elixir # ... end + defp _parse_contents(data) do + # ... + end + # Good :no_match :error @@ -208,6 +212,10 @@ The following section are automatically applied by the code formatter in Elixir def read_file(path) do # ... end + + defp parse_contents(data) do + # ... + end ``` * From 4517afb5c8c95146938a9b740efb7d9046f52134 Mon Sep 17 00:00:00 2001 From: Miles Sorlie Date: Sun, 13 Sep 2020 14:50:21 -0600 Subject: [PATCH 2/2] make function public, add doc false --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4137133..939ad78 100644 --- a/README.md +++ b/README.md @@ -196,7 +196,7 @@ The following section are automatically applied by the code formatter in Elixir # ... end - defp _parse_contents(data) do + def _parse_contents(data) do # ... end @@ -213,7 +213,8 @@ The following section are automatically applied by the code formatter in Elixir # ... end - defp parse_contents(data) do + @doc false + def parse_contents(data) do # ... end ```