DEV Community

Cover image for Ensuring accuracy of README code snippets

Ensuring accuracy of README code snippets

Zak Henry on June 20, 2019

The problem It is the first interaction a developer will have with your library. They hear about the library through various means, but ...
Collapse
 
florimondmanca profile image
Florimond Manca • Edited

I’ve encountered and thought about this problem before, but it’s really amazing that someone actually tackled it with such a clever solution — I refer to using file name comments, which are often already present anyway. :-) Great work!

Collapse
 
florimondmanca profile image
Florimond Manca • Edited

P.S.: I think you should use the #showdev tag on this one, this post deserves it!

Collapse
 
anwar_nairi profile image
Anwar

This is what I frigging needed! Great job, can't wait to use it for my API documentation!

Collapse
 
val_baca profile image
Valentin Baca

What a neat solution. Thanks for sharing!

Collapse
 
eckdaniel profile image
Danny Eck

Use MDX and raw.macro