Skip to content

Commit bfa64f5

Browse files
committed
Add test reproducing false negative for ModuleDoc
Refs #1168
1 parent cf40ca2 commit bfa64f5

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

test/credo/check/readability/module_doc_test.exs

+29
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,21 @@ defmodule Credo.Check.Readability.ModuleDocTest do
5353
|> refute_issues()
5454
end
5555

56+
test "it should NOT report modules or submodules when @moduledoc is present" do
57+
"""
58+
defmodule Foo do
59+
@moduledoc false
60+
61+
defmodule Bar do
62+
@moduledoc false
63+
end
64+
end
65+
"""
66+
|> to_source_file
67+
|> run_check(@described_check, ignore_names: [])
68+
|> refute_issues()
69+
end
70+
5671
#
5772
# cases raising issues
5873
#
@@ -70,6 +85,20 @@ defmodule Credo.Check.Readability.ModuleDocTest do
7085
|> assert_issue()
7186
end
7287

88+
test "it should report modules when @moduledoc is present in submodules only" do
89+
"""
90+
defmodule Foo do
91+
# distinctly no moduledoc here
92+
defmodule Bar do
93+
@moduledoc false
94+
end
95+
end
96+
"""
97+
|> to_source_file
98+
|> run_check(@described_check, ignore_names: [])
99+
|> assert_issue()
100+
end
101+
73102
test "it should report empty strings" do
74103
"""
75104
defmodule CredoSampleModule do

0 commit comments

Comments
 (0)