Add ability to mark @moduledoc false as failures as well as missing @… #42
Conversation
|
Thanks for the contribution! Really appreciate it :). I'll take a look some time this week and merge this one in as well as cut a new release! |
Any update on this? Was going to hopefully throw it in my company's mix file instead of forking it! |
|
Just following up! |
|
@balexandr do you mind taking a look at the failing jobs? 🙏🏻 |
# Conflicts: # lib/module_report.ex # test/module_report_test.exs
|
@yordis Updated, tests passing locally. |
README.md
Outdated
| @@ -129,7 +129,8 @@ the default Doctor settings. The default file contents are: | |||
| raise: false, | |||
| reporter: Doctor.Reporters.Full, | |||
| struct_type_spec_required: true, | |||
| umbrella: false | |||
| umbrella: false, | |||
| include_hidden_doc: false | |||
There was a problem hiding this comment.
Thoughts on renaming the option to fail_hidden_doc instead? I think that makes it more clear what the option does.
There was a problem hiding this comment.
@akoutmos Updated nomenclature, this error seems odd, locally it doesn't hit.
~/C/doctor ❯❯❯ MIX_ENV=test mix test add-hidden-doc-config
............................................
Finished in 0.4 seconds (0.1s async, 0.2s sync)
44 tests, 0 failures
There was a problem hiding this comment.
I reverted the reorganization so let's see where it fails now even though it fails for me locally now.
|
Updated! |
|
@akoutmos any change to review the PRs, merge some and cut a new release? Maybe a 1.0 for now (just to go with semver) |
Added the ability to mark hidden docs i.e.
@moduledoc falseas a failureAdded an empty Map as a check to confirm if a module doc is missing
Updated README
Added Test