`runnableExamples` got vastly improved after that original thread time ~2018!

I am a strong proponent of using `runnableExamples`. If you see any issues with 
it, may be it deserves a new thread.

* * *

Few examples of runnableExamples loaded docs written by me:

  * [elnim](https://kaushalmodi.github.io/elnim/)
  * [std_vector](https://clonkk.github.io/nim-cppstl/cppstl/std_vector.html)
  * [ptr_math](https://kaushalmodi.github.io/ptr_math/)



* * *

@exelotl

> When viewing docs I would much rather read: (examples of echo statements)

But those echo docs are hard to maintain; at some point you will end up with 
mismatching code and echo examples.

`doAssert` or `assert` based examples in `runnableExamples` can also be 
new-user friendly.. it depends on the style of writing those assertions.

The best part is that to try out a `runnableExample`, the reader simply needs 
to import that library, copy/paste that `runnableExamples` snippet and expect 
that to Just Work.

Reply via email to