Merge pull request #102 from aws-beam/improvements-to-erlang-docs

Improvements to erlang docs

lib/aws_codegen/docstring.ex

@@ -274,18 +274,23 @@ defmodule AWS.CodeGen.Docstring do
         if String.contains?(text, "\n") do
           "\n```\n#{String.trim_leading(text, "\n")}'''#{@two_break_lines}"
         else
-          "`#{text}'"
+          ## ex_doc blows up on these sorts of things as it sees them as a reference to a function.
+          ## Just ignore them as they refer to aws-sdk-go based implementations and we don't really care about that
+          if String.ends_with?(text, "()") do
+            ""
+          else
+            "`#{text}'"
+          end
         end
 
-      {"a", attrs, children} = html_node ->
+      {"a", attrs, children} ->
         case Enum.find(attrs, fn {attr, _} -> attr == "href" end) do
           {_, href} ->
             text = Floki.text(children)
-
             if text == href do
               "[#{href}]"
             else
-              html_node
+              "#{text}: #{href}"
             end
 
           nil ->

test/aws_codegen/docstring_test.exs

@@ -211,7 +211,7 @@ defmodule AWS.CodeGen.DocstringTest do
           """
           %% @doc A short description.
           %%
-          %% This is a <a href="https://foo.bar">link</a>.
+          %% This is a link: https://foo.bar.
           %% This is a `code' and a multiline is here:
           %%
           %% ```