Your help is most welcome! > How should I handle testing these examples? Should I use runnableExamples? > I've never used it before. Could someone demonstrate?
that's why we need a detailed guideline doc showing latest best practices with code snippets (which I started here [https://github.com/nim-lang/Nim/pull/8271](https://github.com/nim-lang/Nim/pull/8271)) > Should I use runnableExamples? yes for the most common usage, not meant as replacement for proper unittesting; search in doc for runnableExamples and run nim doc foo/bar.nim : it'll run these (but see caveat here: [https://github.com/nim-lang/Nim/issues/7280](https://github.com/nim-lang/Nim/issues/7280)) and generate bar.html which you can inspect for formatting issues if needed (see also [https://github.com/nim-lang/Nim/issues/8477](https://github.com/nim-lang/Nim/issues/8477) which is a meta issue listing documentation issues I ran across). Please report any bug you encounter with runnableExamples (after checking they're not already reported) > What procs really need examples? > I suppose it's the more advanced ones that > should be documented? ideally every symbol should be documented but we need to prioritize; so here's a simple heuristic: look for modules with few runnableExamples that are you're either familiar with or that are more commonly used: nimgrep --ignoreStyle --ext:nim --recursive --oneline runnableExamples > Does each module get a separate pull request, or is it just one pull request > for a chunk of work across modules? I think 1 PR per module is good; keep in mind PR's are queued and each push to a PR uses up resources on travis/appveyor (and takes a loooong time)
