Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Extract runnables that specify rdoccmd #19275

Merged
merged 1 commit into from
Dec 20, 2021
Merged

Extract runnables that specify rdoccmd #19275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/core/macros.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1715,8 +1715,8 @@ proc extractDocCommentsAndRunnables*(n: NimNode): NimNode =
case ni.kind
of nnkCommentStmt:
result.add ni
of nnkCall:
if ni[0].kind == nnkIdent and ni[0].strVal == "runnableExamples":
of nnkCall, nnkCommand:
if ni[0].kind == nnkIdent and ni[0].eqIdent "runnableExamples":
result.add ni
else: break
else: break
20 changes: 20 additions & 0 deletions tests/stdlib/tmacros.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,23 @@ block: # SameType
assert not testTensorInt(x1)
assert testTensorInt(x2)
assert not testTensorInt(x3)

block: # extractDocCommentsAndRunnables
macro checkRunnables(prc: untyped) =
let runnables = prc.body.extractDocCommentsAndRunnables()
doAssert runnables[0][0].eqIdent("runnableExamples")

macro checkComments(comment: static[string], prc: untyped) =
let comments = prc.body.extractDocCommentsAndRunnables()
doAssert comments[0].strVal == comment

proc a() {.checkRunnables.} =
runnableExamples: discard
discard

proc b() {.checkRunnables.} =
runnableExamples "-d:ssl": discard
discard

proc c() {.checkComments("Hello world").} =
## Hello world