search

akoutmos / doctor

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

Elixir 1.8+ required due to use of Mix.Task.recursing? #33

Closed karolsluszniak closed 3 years ago

karolsluszniak commented 3 years ago

Hi there! Great work on this library, I've just discovered it via https://akoutmos.com/post/elixir-cicd (also great, quality stuff) and opened https://github.com/karolsluszniak/ex_check/pull/26 to add it as a default curated tool in ex_check so that more Elixir developers may discover it and include docs in their CI checklist.

And since ex_check's test suite runs on Elixir 1.7 and 1.10, the former has discovered that doctor suffers from issue similar to this one: https://github.com/xerions/phoenix_swagger/issues/242 - i.e. use of Mix.Task.recursing? requires Elixir 1.8+ even though doctor declares 1.7+ in mix.exs.

Zrzut ekranu 2021-01-11 o 16 46 36

I'll cover this issue on ex_check's side by only activating doctor in Elixir 1.8+.

akoutmos commented 3 years ago

Good catch! And a huge thanks for considering adding Doctor to ex_check :+1:. That is awesome news and I think the community will benefit from having healthy documentation ;). I just published 0.17.0 to hex and bumped the Elixir version requirement to 1.8 as you suggested.

Looking forward to seeing karolsluszniak/ex_check#26 merged in. Thanks!