[TODO] [runnableExamples] miscellaneous issues

[timotheecour]

major

• runnableExamples should preserve source code doc comments, strings, and (maybe) formatting runnableExamples should preserve source code doc comments, strings, and (maybe) formatting #8871
• [runnableExamples] relative imports import ./foo should be rebased in runnableExamples, otherwise gives "Error: cannot open file" [runnableExamples] relative imports import ./foo should be rebased in runnableExamples, otherwise gives "Error: cannot open file" #8878
• Some runnable examples are not executed. Some runnable examples are not executed. #7280
• runnableExamples doesn't work at module level runnableExamples doesn't work at module level #8641
• WONTFIX: proposal: a runnableExamples below a proc becomes part of that symbol doc; would fix Some runnable examples are not executed. #7280 and result in easier to read code proposal: a runnableExamples below a proc becomes part of that symbol doc; would fix #7280 and result in easier to read code #8536
• Error: undeclared identifier: '|' when using | inside a runnableExamples: Error: undeclared identifier: '|' when using | inside a runnableExamples: #8694

minor

• X_examples.nim generated by runnableExamples should show line number where they came from X_examples.nim generated by runnableExamples should show line number where they came from #8289
• for each runnableExamples, show the corresponding proc name being run so we know it's being executed
• maybe warn or log smthg when a runnableExamples corresponds to a private symbol; right now it just does nothing

links

./compiler/semexprs.nim
 keep the imports in runnableExamples visible in generated html doc (#8354)

[dom96]

What's the purpose of this issue? Just a list of other issues? Why?

[timotheecour]

in short, it helps organize:

• they're all related and I find it very helpful when I'm working on a PR for fixing 1 issue to see other related issues
• it helps track progress towards fixing a category of bugs; harder to tell the big picture without this meta-issue
• sometimes it's more convenient to just add a bug to this list without creating a separate issue

for example in https://github.com/nim-lang/Nim/issues/8177 ([ospaths, os] miscellaneous issues), searching by issue title "ospaths" would not be enough, searching by issue content with "ospaths" would have false positives. Having that list for ospaths helps me each time I'm working on any of the bugs there; easy to find and easy to see related ones 1 click away.

[Araq]

https://github.com/nim-lang/Nim/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+runnableExamples+in%3Atitle

Just use a github issue filter.