From 0de3d4292f328f94c7a94af7e3e61e58ff43a252 Mon Sep 17 00:00:00 2001 From: Timothee Cour Date: Wed, 2 Jun 2021 09:02:14 -0700 Subject: fix #16993, #18054, #17835 runnableExamples now works with templates and nested templates (#18082) --- nimdoc/testproject/expected/subdir/subdir_b/utils.html | 4 ++-- nimdoc/testproject/expected/testproject.html | 11 ++++++----- nimdoc/testproject/subdir/subdir_b/utils.nim | 10 +++++++--- 3 files changed, 15 insertions(+), 10 deletions(-) (limited to 'nimdoc/testproject') diff --git a/nimdoc/testproject/expected/subdir/subdir_b/utils.html b/nimdoc/testproject/expected/subdir/subdir_b/utils.html index 794066cae..826cad02a 100644 --- a/nimdoc/testproject/expected/subdir/subdir_b/utils.html +++ b/nimdoc/testproject/expected/subdir/subdir_b/utils.html @@ -206,9 +206,9 @@ constructor. 
template fromUtilsGen(): untyped
-this should be shown in utils.html +should be shown in utils.html only

Example:

-
assert 3*2 == 6
ditto +
discard "should be in utils.html only, not in module that calls fromUtilsGen"
ditto
diff --git a/nimdoc/testproject/expected/testproject.html b/nimdoc/testproject/expected/testproject.html index d2fe38021..513dd507b 100644 --- a/nimdoc/testproject/expected/testproject.html +++ b/nimdoc/testproject/expected/testproject.html @@ -431,10 +431,7 @@ window.addEventListener('DOMContentLoaded', main); discard "in top2"top2 after

Example:

import testproject
-discard "in top3"
top3 after -

Example:

-
import testproject
-assert 3*2 == 6

+discard "in top3"top3 after

Imports

@@ -574,7 +571,8 @@ My someFunc. Stuff in fromUtilsGen is called

Example:

-
discard 1
+
discard """should be shown as examples for fromUtils3
+       in module calling fromUtilsGen"""
@@ -957,6 +955,9 @@ cz18
ok3 +

Example:

+
discard """should be shown as examples for fromUtils2
+       in module calling fromUtilsGen"""
diff --git a/nimdoc/testproject/subdir/subdir_b/utils.nim b/nimdoc/testproject/subdir/subdir_b/utils.nim index 128e8e481..4e3aa1f10 100644 --- a/nimdoc/testproject/subdir/subdir_b/utils.nim +++ b/nimdoc/testproject/subdir/subdir_b/utils.nim @@ -50,9 +50,9 @@ template bEnum*(): untyped = discard template fromUtilsGen*(): untyped = - ## this should be shown in utils.html + ## should be shown in utils.html only runnableExamples: - assert 3*2 == 6 + discard "should be in utils.html only, not in module that calls fromUtilsGen" ## ditto iterator fromUtils1*(): int = @@ -64,7 +64,11 @@ template fromUtilsGen*(): untyped = template fromUtils2*() = ## ok3 + runnableExamples: + discard """should be shown as examples for fromUtils2 + in module calling fromUtilsGen""" proc fromUtils3*() = ## came form utils but should be shown where `fromUtilsGen` is called - runnableExamples: discard 1 + runnableExamples: discard """should be shown as examples for fromUtils3 + in module calling fromUtilsGen""" -- cgit 1.4.1-2-gfad0