Skip to content

Commit 7fd5238

Browse files
committed
Add test for warnings if referencing filtered typespec
Closes #1764
1 parent 062e181 commit 7fd5238

File tree

2 files changed

+6
-11
lines changed

2 files changed

+6
-11
lines changed

lib/ex_doc/language/elixir.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,7 @@ defmodule ExDoc.Language.Elixir do
670670
original_text = call_string <> "()"
671671

672672
if Enum.any?(config.filtered_modules, &(&1.id == module_string)) do
673-
Autolink.warn(config, "Typespec references filtered module: #{all}")
673+
Autolink.warn(config, "typespec references filtered module: #{all}")
674674
end
675675

676676
url =

test/ex_doc/language/elixir_test.exs

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -470,16 +470,6 @@ defmodule ExDoc.Language.ElixirTest do
470470
~s|<code class="inline">t:InMemory.unknown/0</code>|
471471
end
472472

473-
test "warning if typespec references filtered module" do
474-
ExDoc.Refs.insert([
475-
{{:module, AutolinkTest.Keep}, :public},
476-
{{:function, AutolinkTest.Filtered}, :public},
477-
{{:type, AutolinkTest.Filtered, :type, 0}, :public}
478-
])
479-
480-
# TODO: testing
481-
end
482-
483473
test "warnings" do
484474
ExDoc.Refs.insert([
485475
{{:module, AutolinkTest.Foo}, :public},
@@ -578,6 +568,11 @@ defmodule ExDoc.Language.ElixirTest do
578568
autolink_spec(quote(do: t() :: String.bad()), opts)
579569
end) =~ ~s|documentation references type "String.bad()"|
580570

571+
assert warn(fn ->
572+
opts = opts ++ [filtered_modules: [%ExDoc.ModuleNode{id: "String"}]]
573+
autolink_spec(quote(do: t() :: String.t()), opts)
574+
end) == "typespec references filtered module: String.t()"
575+
581576
assert warn(fn ->
582577
autolink_spec(
583578
quote do

0 commit comments

Comments
 (0)