fix #16993, #18054, #17835 runnableExamples now works with templates and nested templates #18082
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timotheecour
commented
May 24, 2021
| assertImpl(cond, msg, astToStr(cond), true) | ||
|
|
||
| template onFailedAssert*(msg, code: untyped): untyped {.dirty.} = | ||
| ## Sets an assertion failure handler that will intercept any assert | ||
| ## statements following `onFailedAssert` in the current scope. | ||
| runnableExamples: | ||
| type MyError = object of CatchableError |
There was a problem hiding this comment.
i've also improved a bit the examples after moving them at template scope
timotheecour
commented
May 24, 2021
| action: "compile" | ||
| nimoutFull: true |
timotheecour
force-pushed
the
pr_runnableExamples_template
branch
from
25300b7
to
656e602
Compare
timotheecour
added
the
Ready For Review
ringabout
approved these changes
May 26, 2021
timotheecour
commented
May 26, 2021
| <p><strong class="examples_text">Example:</strong></p> | ||
| <pre class="listing"><span class="Identifier">assert</span> <span class="DecNumber">3</span><span class="Operator">*</span><span class="DecNumber">2</span> <span class="Operator">==</span> <span class="DecNumber">6</span></pre>ditto | ||
| <pre class="listing"><span class="Keyword">discard</span> <span class="StringLit">"should be in utils.html only, not in module that calls fromUtilsGen"</span></pre>ditto |
There was a problem hiding this comment.
no it's there, see hould be in utils.html only, not in module that calls fromUtilsGen
Araq
reviewed
May 26, 2021
| runnableExamples: | ||
| assert 3*2 == 6 | ||
| discard "should be in utils.html only, not in module that calls fromUtilsGen" |
There was a problem hiding this comment.
Why was this changed? Does the assert inside a runnableExample inside a template still work?
There was a problem hiding this comment.
yes, of course assert still works, the new comment makes it clear when you look at nim sources + generated file where it came from and where it should end up
There was a problem hiding this comment.
this is also tested via tests/nimdoc/trunnableexamples.nim btw
|
ping @Araq |
PMunch
pushed a commit
to PMunch/Nim
that referenced
this pull request
Mar 28, 2022
…ow works with templates and nested templates (nim-lang#18082)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix #16993
fix #18054
fix #17835
close #17842 as this is a proper fix whereas #17842 was a workaround
the diff in nimdoc/testproject/subdir/subdir_b/utils.nim sums it up.
future work
code-blockhas almost no use cases left in nim sources and should be replaced byrunnableExamplesrunnableExamples(inject = true)to inject the runnableExamples of a templatefooat the place wherefoois called, but this is a niche feature, and the main use case is the one implemented by this PR (as evidenced by those bug reports)notes
related past issues (dealing with doc comments instead of runnableExamples):
#9596, #9432, #9626, #9473, #9469
I also encountered #18077 while fixing this (EDIT: fixing it here: #18086)