Use clearer name on ExDoc.DocAST

Author: josevalim

lib/ex_doc/doc_ast.ex

@@ -113,19 +113,16 @@ defmodule ExDoc.DocAST do
   @doc """
   Returns text content from the given AST.
   """
-  def text_from_ast(ast) do
+  def text(ast) do
     ast
-    |> do_text_from_ast()
+    |> do_text()
     |> IO.iodata_to_binary()
     |> String.trim()
   end
 
-  def do_text_from_ast(ast) when is_list(ast) do
-    Enum.map(ast, &do_text_from_ast/1)
-  end
-
-  def do_text_from_ast(ast) when is_binary(ast), do: ast
-  def do_text_from_ast({_tag, _attr, ast, _meta}), do: text_from_ast(ast)
+  defp do_text(ast) when is_list(ast), do: Enum.map(ast, &do_text/1)
+  defp do_text(ast) when is_binary(ast), do: ast
+  defp do_text({_tag, _attr, ast, _meta}), do: text(ast)
 
   @doc """
   Wraps a list of HTML nodes into `<section>` tags whenever `matcher` returns true.
@@ -160,6 +157,7 @@ defmodule ExDoc.DocAST do
   @doc """
   Highlights a DocAST converted to string.
   """
+  # TODO: Could this be done over the AST instead?
   def highlight(html, language, opts \\ []) do
     highlight_info = language.highlight_info()
 

lib/ex_doc/formatter/html.ex

@@ -422,7 +422,7 @@ defmodule ExDoc.Formatter.HTML do
         :error -> {nil, ast}
       end
 
-    title_text = title_ast && ExDoc.DocAST.text_from_ast(title_ast)
+    title_text = title_ast && ExDoc.DocAST.text(title_ast)
     title_html = title_ast && ExDoc.DocAST.to_string(title_ast)
     content_html = autolink_and_render(ast, language, [file: input] ++ autolink_opts, opts)
 

lib/ex_doc/formatter/html/search_data.ex

@@ -117,6 +117,7 @@ defmodule ExDoc.Formatter.HTML.SearchData do
     }
   end
 
+  # TODO: Perform this via DocAST and remove doc_format (and perhaps source_doc)
   defp extract_sections("text/markdown", %{source_doc: %{"en" => doc}}) do
     extract_sections_from_markdown(doc)
   end