2 ms·
Preferably the author doesn't copy and paste: preferably there's a documentation build step where everything gets run, relevant outputs get inserted into the do
by gmac 5y ago
Preferably the author doesn't copy and paste: preferably there's a documentation build step where everything gets run, relevant outputs get inserted into the docs, and any errors get caught.
This is how my docs for Zapatos[1] work, for instance. :)
[1] https://jawj.github.io/zapatos/ https://jawj.github.io/zapatos/
- j1elo 5y agoIt is probably too much to ask everyone follow the same approach, so I'll be happy if people just test their own commands by hand. But your doc build step that validates code and catches errors? That's the ideal setup, for sure. Great job!