We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
mix credo -v
elixir -v
When having nested module definitions, an inner module having @moduledoc will silence the credo check for the outer module.
@moduledoc
Consider the following code:
defmodule Foo do # distinctly no moduledoc here defmodule Bar do @moduledoc false end end
Code Readability ┃ ┃ [R] → Modules should have a @moduledoc tag. ┃ example.ex:1:11 #(Foo)
found no issues.
The text was updated successfully, but these errors were encountered:
Add test reproducing false negative for ModuleDoc
bfa64f5
Refs #1168
Thx for reporting! 👍 I added a test reproducing this 👍
Sorry, something went wrong.
Fix false negative for ModuleDoc
bb54b0f
Thanks for reporting this 😀 It is now fixed on master.
master
You can try this by setting the Credo dep to
{:credo, github: "rrrene/credo"}
Please report back if your issue is solved! 👍
I can confirm it to be working.
Many thanks for your time and effort. And thank you for this helpful project!
No branches or pull requests
Environment
mix credo -v
): 1.7.10elixir -v
): Elixir 1.17.3 (compiled with Erlang/OTP 27)What were you trying to do?
When having nested module definitions, an inner module having
@moduledoc
will silence the credo check for the outer module.Consider the following code:
Expected outcome
Actual outcome
found no issues.
The text was updated successfully, but these errors were encountered: