Refactor docs

.credo.exs

@@ -80,7 +80,7 @@
         #
         ## Readability Checks
         #
-        {Credo.Check.Readability.AliasOrder, []},
+        {Credo.Check.Readability.AliasOrder, false},
         {Credo.Check.Readability.FunctionNames, []},
         {Credo.Check.Readability.LargeNumbers, []},
         {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 135]},

lib/elixir_sense.ex

@@ -44,14 +44,13 @@ defmodule ElixirSense do
       ...>   MyEnum.to_list(1..3)
       ...> end
       ...> '''
-      iex> %{docs: docs} = ElixirSense.docs(code, 3, 11)
-      iex> docs |> String.split("\n") |> Enum.at(8)
+      iex> %{docs: [doc]} = ElixirSense.docs(code, 3, 11)
+      iex> doc.docs |> String.split("\n") |> Enum.at(0)
       "Converts `enumerable` to a list."
   """
   @spec docs(String.t(), pos_integer, pos_integer) ::
           %{
-            actual_subject: String.t(),
-            docs: nil | String.t(),
+            docs: nonempty_list(Docs.doc()),
             range: %{
               begin: {pos_integer, pos_integer},
               end: {pos_integer, pos_integer}
@@ -69,18 +68,17 @@ defmodule ElixirSense do
         env = Metadata.get_env(metadata, {line, column})
 
         case Docs.all(context, env, metadata) do
-          {actual_subject, docs} ->
+          [] ->
+            nil
+
+          list ->
             %{
-              actual_subject: actual_subject,
-              docs: docs,
+              docs: list,
               range: %{
                 begin: begin_pos,
                 end: end_pos
               }
             }
-
-          nil ->
-            nil
         end
     end
   end

lib/elixir_sense/core/applications.ex

@@ -26,6 +26,7 @@ defmodule ElixirSense.Core.Applications do
   @spec get_modules_from_applications() :: [module]
   # TODO use :code.all_available |> Enum.map(fn {m, _, _} -> :"#{m}" end) on otp 23+
   # as it returns more
+  # NOTE this function does not return modules from :erts app as it is not loaded
   def get_modules_from_applications do
     for [app] <- loaded_applications(),
         {:ok, modules} = :application.get_key(app, :modules),

lib/elixir_sense/core/erlang_html.ex

@@ -1,7 +1,7 @@
 defmodule ElixirSense.Core.ErlangHtml do
   @moduledoc false
 
-  # those typedefs mimic erl_docgen types (as of OTP 24) to not introduce dependency
+  # those typedefs mimic erl_docgen types (as of OTP 26) to not introduce dependency
   @type chunk_elements() :: [chunk_element()]
   @type chunk_element() ::
           {chunk_element_type(), chunk_element_attrs(), chunk_elements()}
@@ -104,6 +104,7 @@ defmodule ElixirSense.Core.ErlangHtml do
 
   def to_markdown({:pre, _attrs1, [{:code, _attrs2, inner}]}, parents, _sanitize_mode) do
     prefix = build_prefix(parents)
+    # TODO should we fence it as erlang?
     "```\n" <> prefix <> to_markdown(inner, parents, :none) <> "\n" <> prefix <> "```\n" <> prefix
   end