akoutmos / doctor

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

Comparison to Inch in README #22

Closed lpil closed 4 years ago

lpil commented 4 years ago

Hello!

Would it be possible to include a comparison to Inch? https://github.com/rrrene/inch_ex

Upon first inspection it's not obvious to a newcomer such as myself how to decide between Doctor and Inch.

Thank you

akoutmos commented 4 years ago

That's a good idea! There is a little bit of over lap between doctor/credo/inch so it would probably be helpful for users to know what tool is applicable in what situation. I'll add something to the README later today.

Appreciate the feedback :)

lpil commented 4 years ago

Thank you :)

On Mon, 8 Jun 2020, 15:27 Alexander Koutmos, notifications@github.com wrote:

That's a good idea! There is a little bit of over lap between doctor/credo/inch so it would probably be helpful for users to know what tool is applicable in what situation. I'll add something to the README later today.

Appreciate the feedback :)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/akoutmos/doctor/issues/22#issuecomment-640658016, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABOZVBQBYSL7XTUVLLJYDI3RVTYN5ANCNFSM4NYKFOAA .

akoutmos commented 4 years ago

Documentation has been updated to address the differences between Doctor/Inch/Credo https://github.com/akoutmos/doctor#comparison-with-other-tools. Closing this issue for now. Feel free to reopen if I missed anything. Thanks!