In my codebase, we are missing a lot of moduledocs. We'd like to count moduledocs and have a threshold to pass CI, but prior to this PR, moduledoc_required was only a boolean. That meant that either the requirement is enabled and ALL modules needed a moduledoc to pass or it was disabled.
With this change, users will get a deprecation warning if they still have the option in their config. The message reads something like
10:51:37.787 [warning] :moduledoc_required in .doctor.exs is a deprecated option. Now running with the equivalent :min_overall_moduledoc_coverage 100 but you should replace the deprecated option with the new one to avoid this warning.
Also, I updated the elixir version in the github action yaml. (The formatter and unit tests were both failing in CI.) Coveralls was then throwing a weird error after the tests ran, so I went ahead and just updated all the deps to the latest.
In my codebase, we are missing a lot of moduledocs. We'd like to count moduledocs and have a threshold to pass CI, but prior to this PR,
moduledoc_requiredwas only a boolean. That meant that either the requirement is enabled and ALL modules needed a moduledoc to pass or it was disabled.With this change, users will get a deprecation warning if they still have the option in their config. The message reads something like
Also, I updated the elixir version in the github action yaml. (The formatter and unit tests were both failing in CI.) Coveralls was then throwing a weird error after the tests ran, so I went ahead and just updated all the deps to the latest.