improve rendering of builtin type docs

elixir-lsp · Jul 28, 2023 · 33cf5ab · 33cf5ab
1 parent b0f45bf
commit 33cf5ab
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/lib/elixir_sense/core/introspection.ex b/lib/elixir_sense/core/introspection.ex
@@ -478,15 +478,15 @@ defmodule ElixirSense.Core.Introspection do
         matches_arity?(length(info.params), arity) do
       {spec, args} =
         case info do
-          %{signature: sig, params: params} ->
-            {sig, Enum.map_join(params, ", ", &(&1 |> Atom.to_string()))}
+          %{signature: signature, params: params} ->
+            {"@type #{signature}", Enum.map_join(params, ", ", &(&1 |> Atom.to_string()))}
 
           %{spec: spec_ast, params: params} ->
             {TypeInfo.format_type_spec_ast(spec_ast, :type),
              Enum.map_join(params, ", ", &(&1 |> Atom.to_string()))}
 
           _ ->
-            {"#{fun}()", ""}
+            {"@type #{fun}()", ""}
         end
 
       format_type_doc_md({nil, fun}, args, info[:doc], spec, %{builtin: true})
@@ -1429,7 +1429,7 @@ defmodule ElixirSense.Core.Introspection do
         atom -> inspect(atom) <> "."
       end
 
-    "> #{mod_formatted}#{fun}(#{type_args})\n\n#{get_metadata_md(metadata)}### Specs\n\n#{formatted_spec}\n\n#{doc}"
+    "> #{mod_formatted}#{fun}(#{type_args})\n\n#{get_metadata_md(metadata)}### Definition\n\n#{formatted_spec}\n\n#{doc}"
   end
 
   def is_pub(type), do: type in [:def, :defmacro, :defdelegate, :defguard]

diff --git a/test/elixir_sense/core/introspection_test.exs b/test/elixir_sense/core/introspection_test.exs
@@ -818,7 +818,7 @@ defmodule ElixirSense.Core.IntrospectionTest do
              **Since**
              1.1.0
 
-             ### Specs
+             ### Definition
 
              ```
              @type some_type() :: integer()

diff --git a/test/elixir_sense/docs_test.exs b/test/elixir_sense/docs_test.exs
@@ -407,7 +407,7 @@ defmodule ElixirSense.DocsTest do
       assert docs == """
              > ElixirSenseExample.ModuleWithTypespecs.Remote.remote_t()
 
-             ### Specs
+             ### Definition
 
              ```
              @type remote_t() :: atom()
@@ -438,7 +438,7 @@ defmodule ElixirSense.DocsTest do
 
              **Opaque**
 
-             ### Specs
+             ### Definition
 
              ```
              @opaque t(x)
@@ -468,7 +468,7 @@ defmodule ElixirSense.DocsTest do
       assert docs =~ """
              > :erlang.time_unit()
 
-             ### Specs
+             ### Definition
 
              ```
              @type time_unit() ::
@@ -512,7 +512,7 @@ defmodule ElixirSense.DocsTest do
 
              **Built-in**
 
-             ### Specs
+             ### Definition
 
              ```
              @type keyword() :: [{atom(), any()}]
@@ -533,7 +533,7 @@ defmodule ElixirSense.DocsTest do
 
              **Built-in**
 
-             ### Specs
+             ### Definition
 
              ```
              @type keyword(t) :: [{atom(), t}]
@@ -563,10 +563,10 @@ defmodule ElixirSense.DocsTest do
 
              **Built-in**
 
-             ### Specs
+             ### Definition
 
              ```
-             integer()
+             @type integer()
              ```
 
              An integer number
@@ -595,7 +595,7 @@ defmodule ElixirSense.DocsTest do
 
              **Built-in**
 
-             ### Specs
+             ### Definition
 
              ```
              @type list() :: [any()]
@@ -616,10 +616,10 @@ defmodule ElixirSense.DocsTest do
 
              **Built-in**
 
-             ### Specs
+             ### Definition
 
              ```
-             list(t)
+             @type list(t)
              ```
 
              Proper list ([]-terminated)