akoutmos / doctor

Ensure that your Elixir project documentation is healthy
MIT License
179 stars 15 forks source link

Don't analyze `defimpl` modules #45

Closed christhekeele closed 1 year ago

christhekeele commented 2 years ago

Hey there! I've noticed that doctor reports on modules generated by defimpl.

Credo ignores these modules today during @defmodule checks. defimpl modules do not appear in ex_doc, so this makes sense.

Interestingly, doctor does seem to recognize that my undocumented functions in my defimpls do not count! doc/spec coverage for the module is N/A and counts are 0'd out. However, it still reports on the module, and complains about a missing @moduledoc.