Skip to content

Commit 196aab8

Browse files
committed
Align doc chunks return with EEP 48
1 parent 59b2665 commit 196aab8

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

lib/elixir/lib/behaviour.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ defmodule Behaviour do
111111
end
112112
end
113113

114-
defp __behaviour__doc_value(:none), do: nil
115-
defp __behaviour__doc_value(:hidden), do: false
116114
defp __behaviour__doc_value(%{"en" => doc}), do: doc
115+
defp __behaviour__doc_value(:hidden), do: false
116+
defp __behaviour__doc_value(_), do: nil
117117

118118
import unquote(__MODULE__)
119119
end

lib/elixir/lib/code.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@ defmodule Code do
13481348
| {:error, :module_not_found | :chunk_not_found | {:invalid_chunk, binary}}
13491349
when annotation: :erl_anno.anno(),
13501350
beam_language: :elixir | :erlang | atom(),
1351-
doc_content: %{required(binary) => binary} | :none | :hidden,
1351+
doc_content: %{optional(binary) => binary} | :none | :hidden,
13521352
doc_element:
13531353
{{kind :: atom, function_name :: atom, arity}, annotation, signature, doc_content,
13541354
metadata},

lib/elixir/lib/kernel/typespec.ex

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ defmodule Kernel.Typespec do
2323
for {{:type, name, arity}, _, _, doc, _} <- docs do
2424
case doc do
2525
%{"en" => doc_string} -> {{name, arity}, doc_string}
26+
%{} -> {{name, arity}, nil}
2627
:none -> {{name, arity}, nil}
2728
# Hidden or unknown format are ignored
2829
_ -> {{name, arity}, false}

0 commit comments

Comments
 (0)