lenards
Any way to use Credo to check for `ExUnit.DocTest.doctest` occurrences?
I recently noticed in our codebase had some iex> usage in doc strings, but those modules did not have a corresponding ExUnit.DocTest.doctest/2. Some of the authors of these helpful iex> examples did not realize there was an extra step to get this examples checked as test (when I was new Elixir, I also did not realize this).
Is there any way to automate checks for this? Or is there something we might add to our Credo configure?
Curious if there might be a way to help avoid missing out on the feedback and checks. I love DocTest examples and want to keep promote their use.
Thanks in advance for thoughts or points.
First Post!
kanishka
For now, I created this small documentation PR: Update docs-tests-and-with.markdown by kacorvus · Pull Request #1669 · elixir-lang/elixir-lang.github.com · GitHub . Maybe others can suggest a better improvement to highlight this area.
Popular in Questions
Other popular topics
Latest on Elixir Forum
Sponsor Spotlight
Develop your skills with books, videos, and courses.
Categories:
Sub Categories:
Forums
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Practical resources that improve the lives of professional developers.
Producing high quality Elixir screencasts since 2017.
Enabling companies to succeed by building software people love.
Courses that'll move you from confusion to "Aha, now I get it!"