search

elixir-lang / elixir-lang.github.com

Website for Elixir
elixir-lang.org
354 stars 822 forks source link

Update docs-tests-and-with.markdown #1669

Closed kacorvus closed 1 year ago

kacorvus commented 1 year ago

It's easy to forget to run the doc tests. It would be nice to emphasis this point more strongly.

josevalim commented 1 year ago

Thank you @kacorvus but I'd prefer to not go ahead with this for now. Pretty much many of the steps in all of the guides are necessary and lead to different behaviour if we don't do them, so I am not sure we should call this one out specifically. And hopefully the example right below it helps too. :) Thanks anyway!

kacorvus commented 1 year ago

Thanks for quick response. The fact that we had multiple engineers overlook the later part of this text might mean it needs to be vertically rearranged, if you have ideas for how to get the instructions for running doctests closer to the text defining how to write a doctest.

josevalim commented 1 year ago

Got it, I will push a comment earlier. Thanks for given more context!