-
Notifications
You must be signed in to change notification settings - Fork 414
New issue
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
Moduledoc tag check should verify if a 'used' module adds a moduledoc tag #530
Comments
Thx for reporting! 👍 I imagine this to be a rather difficult one. |
Yes, it's definetely not trivial to identify these cases. |
this is exactly my issue! I would want to add my own doc for my scheduler. It's credo vs inch in my case. @Joao-M-Almeida did you find any alternatives for this? |
@tckb I disabled credo for this specific issue on this file. I used:
|
I am not familiar with Credo enough to tell if it's possible, but if you load the compiled project in any way, you could actually call something like |
@whatyouhide Credo, at least for now, does not load the compiled project (it solely relies on static source code analysis). That said, I am currently trying to re-iterate on InchEx, using the newly created EEP48 stuff from The short-term question here is: Does it make sense to look at the uncompiled source code searching for |
I think it makes sense to keep it. It still usefull in 90% of the cases. And in the cases where it doesn't work as expected it's easy to disable. |
Hi, thx again for this. Unfortunately, I am closing it due to "it being obsolete" IMHO. If you disagree, please re-open and elaborate! 👍 |
Environment
mix credo -v
): 0.8.10elixir -v
): Elixir 1.6.4 (compiled with OTP 20)What were you trying to do?
Statically analyzing, with
mix credo
, a project that uses quantum to schedule jobs.Quantum requires a scheduler module to be created that follows the following structure:
This causes credo to complain that no moduledoc tag exists for this scheduler module. However, if I add a moduledoc tag the elixir compiler complains that when calling
use Quantum.Scheduler
I amThis is caused by the fact that the
__using__
macro of Quantum.Scheduler adds a module tag by itself.Expected outcome
No issues found by credo
Actual outcome
┃ [R] → Modules should have a @moduledoc tag.
The text was updated successfully, but these errors were encountered: